学習ガイド

OKF チュートリアル

Open Knowledge Format をステップバイステップで学ぶ：基礎の理解から、本番環境対応のナレッジバンドルの生成、検証、公開まで。

ステップ 1：OKF を理解する

Open Knowledge Format (OKF) は、YAML frontmatter 付き Markdown ファイルとして知識をパッケージ化する軽量な方法です。各 OKF ファイルは、1 つの概念、API エンドポイント、データセット、メトリック、またはドキュメントの一部を表します。

frontmatter には構造化されたメタデータ（type、title、description、tags）が含まれ、Markdown 本文には実際の知識コンテンツが含まれます。これにより、OKF は人間が読めて機械が解析できるようになります。

OKF バリデーターは、ドキュメントの構造をチェックし、OKF Score を提供します。テンプレートから始めて、バリデーターに貼り付け、スコアを確認します。

バリデーターは 3 つの主要な指標を表示します：構造（frontmatter の完全性）、カバレッジ（コンテンツの深さ）、接続性（リンクと参照）。フィードバックを使用してドキュメントを改善します。

既存の Web ページから OKF ドキュメントを自動生成できます。Web から OKF ジェネレーターは 3 つのモードをサポート：単一 URL、Sitemap（最大 20 ページ）、または URL リスト。

バッチ生成の場合、ツールは index.md、生成ログ、検証レポート、個別の概念ファイルを含む完全なバンドルを作成します。すべての URL を処理する前に最初のページをプレビューできます。

高い OKF Score は、より良く構造化され、より発見可能な知識を意味します。各次元を改善する方法は次のとおりです：

構造（40 点）： すべての frontmatter フィールドを追加：type（10点）、title（10点）、description（10点）、id（5点）、tags（5点）。
カバレッジ（30 点）： 詳細なコンテンツを書く：空でない本文（10点）、100+ 語（10点）、300+ 語（5点）、見出しを使用（5点）。
接続性（30 点）： リンクを追加：source_url（10点）、内部リンク（10点）、3+ 内部リンク（10点）。

本番環境対応のドキュメントは 90+ 点を目指します。デプロイされた OKF ドキュメントを継続的に監視するには、Live Badge を使用します。

Markdown を知っている必要がありますか？

基本的な Markdown の知識は役立ちますが、OKF はシンプルです：Markdown ファイルの上部に YAML frontmatter を追加するだけです。チュートリアルには必要なすべてが含まれています。

OKF を学ぶのにどのくらい時間がかかりますか？

5-10 分で最初の有効な OKF ドキュメントを作成できます。すべての機能とベストプラクティスを理解するには約 30 分かかります。

どこから始めるべきですか？

ステップ 1 から始めて OKF が何かを理解し、次にステップ 2 でバリデーターを使用して練習します。ステップ 3-4 では、OKF ドキュメントを生成して改善する方法を示します。