ヘルプセンター
よくある質問
Open Knowledge Format、OKF ツール、検証、ベストプラクティスに関するよくある質問の回答を見つけます。
一般
FAQ
Open Knowledge Format とは何ですか？
Open Knowledge Format (OKF) は、厳選された知識を YAML frontmatter 付き Markdown ファイルのディレクトリとしてパッケージ化するための Google Cloud のオープン仕様です。人間と AI エージェントの両方が知識を読めるようにします。
OKF は誰が維持していますか？
OKF は Google Cloud データチームによって Apache-2.0 ライセンスのオープン仕様として公開されました。コミュニティがツールと実装に貢献しています。
OKF v0.1 は安定していますか？
OKF v0.1 はドラフト状態です。コアフォーマットは使用可能ですが、コミュニティがフィードバックを提供し、より多くの実装が出現するにつれて、仕様が変更される可能性があります。
OKF ツールの使用
FAQ
OKF ドキュメントを検証するにはどうすればよいですか？
OKF バリデーターツールを使用します。Markdown コンテンツを貼り付けると、必須の frontmatter、検証ルールをチェックし、詳細な内訳付きの OKF Score を提供します。
Sitemap から OKF をバッチ生成できますか？
はい。Web から OKF ジェネレーターは Sitemap モードをサポートしています。sitemap.xml URL を入力すると、最大 20 ページを処理し、インデックス、ログ、検証レポートを含む完全なバンドルを生成します。
OKF Score とは何ですか？
OKF Score は、3 つの次元でドキュメントの品質を測定する 0-100 の指標です：構造（40%）、カバレッジ（30%）、接続性（30%）。スコアが高いほど、より良く構造化され、より完全な知識を示します。
Live Badge はどのように機能しますか？
Live Badge は、デプロイされた OKF ドキュメント URL を検証し、現在の OKF Score を表示する SVG バッジを生成します。README ファイルやドキュメントに埋め込んで、リアルタイムの検証ステータスを表示できます。
技術的な質問
FAQ
どの frontmatter フィールドが必須ですか？
唯一の必須フィールドは 'type' です。推奨フィールドには、title、description、id、tags、source_url が含まれます。推奨フィールドが欠落している場合の警告については、バリデーターを確認してください。
OKF Score を向上させるにはどうすればよいですか？
完全な frontmatter（type、title、description、id、tags）を追加して構造を改善します。見出し付きの詳細なコンテンツを書いてカバレッジを改善します。source_url と内部リンクを追加して接続性を改善します。
商用プロジェクトで OKF を使用できますか？
はい。OKF は Apache-2.0 ライセンスの下で公開されており、商用利用が可能です。社内ナレッジベース、製品ドキュメント、パブリック API に使用できます。