open-knowledge-format-starter は何をしますか？
Ready-to-fork starter for an AI-maintained knowledge base on the Open Knowledge Format (OKF) v0.1 — Markdown + YAML frontmatter, with a Claude Code skill, conformance validator, and EN/TH docs.
AIメンテナンス型ナレッジベースを構築するためのフォーク可能なスターターキット。Open Knowledge Format (OKF) v0.1準拠のMarkdown + YAMLフロントマター、Claude Codeスキル、適合性バリデータ、英語/タイ語ドキュメントを同梱。
概要
このリポジトリは、Open Knowledge Format (OKF) v0.1 に準拠した、AIエージェント（特にClaude Code）によって維持・管理されるナレッジベースを構築するためのスターターキットです。MarkdownとYAMLフロントマターを使用した明確で構造化されたドキュメントフォーマットを採用しており、人間とAIの両方にとって読みやすく編集しやすい知識ベースを提供します。
主な機能
- Open Knowledge Format (OKF) v0.1 準拠: 知識を標準化された形式で表現します。
- Markdown + YAMLフロントマター: シンプルかつ強力な文書構造。
- Claude Codeスキル: Claude Codeがナレッジベースを効率的に操作するための定義済みスキル。
- 適合性バリデータ: すべてのドキュメントがOKF仕様に準拠していることを自動チェックします。
- 二言語ドキュメント: 英語 (EN) とタイ語 (TH) のドキュメントを提供します。
クイックスタート
- このリポジトリをフォークします。
- クローンを作成します:
git clone https://github.com/<あなたのユーザー名>/open-knowledge-format-starter.git - Claude Codeをプロジェクトディレクトリ内で起動し、提供されたスキルを使用して知識の追加・編集を開始します。
- バリデータを実行して、ドキュメントがOKF v0.1に準拠していることを確認します。
プロジェクト構成
.
├── .claude/
│ └── skills/
│ └── okf-starter.md # Claude Codeスキル定義
├── knowledge-base/ # ナレッジベースのルートディレクトリ
│ ├── en/ # 英語ドキュメント
│ └── th/ # タイ語ドキュメント
├── validator/ # 適合性バリデーションツール
├── SKILL.md # このファイル
└── README.md # プロジェクトのREADME
仕様
各ナレッジドキュメントは、次の構造に従います。
---
title: ドキュメントのタイトル
tags:
- タグ1
- タグ2
language: en | th
created: YYYY-MM-DD
updated: YYYY-MM-DD
---
# ドキュメントタイトル
ここにコンテンツを記述します。通常のMarkdownを使用できます。
バリデーション
適合性バリデーターを実行するには:
./validator/check.sh
これは、knowledge-base/ 内のすべてのドキュメントが必須のYAMLフロントマターフィールドと正しいディレクトリ構造を備えているかをチェックします。
Claude Codeスキル
.claude/skills/okf-starter.md で定義されているClaude Codeスキルにより、エージェントは以下のことが可能になります:
- OKFに準拠した新しいナレッジドキュメントを作成する。
- 既存のドキュメントを検索・更新する。
- ナレッジベース全体のバリデーションを実行する。
- ドキュメントの言語 (EN/TH) を認識し、適切に処理する。
コントリビューション
改善のための提案やプルリクエストは歓迎します。
ライセンス
このプロジェクトは MIT ライセンス の下で公開されています。