oxynote/oxynote

解決する課題

Oxynoteは、技術的な説明、メトリックチャート、APIドキュメントが別々のツール（Notion、Grafana、コードリポジトリなど）に分散し、すぐに同期が取れなくなる「ドキュメントの乖離」という問題を解決します。ライブデータ、ドキュメント、管理コマンドが共存する統合ワークスペースを提供し、チャートとそのコンテキストが常に一緒にレビューされ、更新されることを保証します。

仕組み

Oxynoteは、ドキュメントを構造化されたレビュー可能な資産として扱うセルフホスト型のワークスペースとして機能します。ページ内にPrometheusやSQLデータベースを直接クエリする「ライブメトリック」ブロックを埋め込むことができます。ページへのすべての変更は、pull requestに似たドラフトおよび承認ワークフローを通じて管理でき、チームは公開前にテキスト、チャート、API定義の視覚的な差分を確認できます。また、リアルタイム編集、コメントスレッド、基盤となる依存関係が変更された際にメンテナーに通知する「鮮度フック」などのコラボレーション機能も含まれています。

対象ユーザー

複雑なシステムのドキュメント化、内部APIの管理、インフラストラクチャの監視が必要な技術チーム向けに設計されています。内部サービスに対して「Stripeスタイル」のドキュメント体験を求め、ドキュメントに対して構造化されたコードのようなレビュープロセスを好むユーザーに最適です。汎用的な社内Wikiや、管理されたクラウドホスト型サービスを必要とするユーザー向けではありません。

ハイライト

• 統合ダッシュボード： ライブメトリックチャート、ゲージ、棒グラフを説明テキストの横に直接埋め込めます。
• レビューワークフロー： ドラフトブランチと差分ビューを使用して、ドキュメントやシステム構成の変更をレビューできます。
• リアルタイムコラボレーション： チームメンバーと同時にページを編集し、特定のブロック、図、またはテキスト行にコメントを添付できます。
• 鮮度トラッキング： GitHubファイルやコンテナイメージなどの依存関係を自動的に追跡し、古くなった場合にアラートを受け取れます。
• AI統合： さまざまなLLMプロバイダーやOllama経由のローカルモデルを使用して、ページを編集したりクエリを実行したりできる組み込みアシスタントが含まれています。