Know プロジェクト 執筆ルール

絶対ルール

1. 公式ドキュメントを必ず参照する
2. 公式サイト・GitHubリポジトリを一次情報源とする

3. 二次情報（ブログ・Qiita等）は参考程度

4. 日本語で書く

5. 言語は日本語

6. 専門用語は英語のまま可（例: Agent, RAG, Vector DB）

7. シンプルに書く

8. 無駄な装飾を避ける
9. 1文は短く

10. 箇条書きを活用

11. 正しく書く（正確性最優先）

12. 曖昧な表現を避ける
13. 「〜らしい」「〜かも」は禁止

14. 分からないことは書かない

15. 出典を明記する

16. 公式ドキュメントへのリンクを必ず含める
17. バージョン情報があれば記載

テンプレート

---
tags:
  - タグ1
  - タグ2
---

# タイトル

概要（1-2文）

## 本質

この技術/ツールが解決する問題

## 基本

- 要点1
- 要点2
- 要点3

## 参照

- [公式ドキュメント](URL)

タグ運用ルール

カテゴリ	タグ例
技術領域	agent, rag, llm, vector-db
ライフ	tax, health, finance
ステータス	wip, deprecated

新規ドキュメント追加チェックリスト

• [ ] frontmatter に tags を記載した
• [ ] 公式ドキュメントへのリンクを含めた
• [ ] mkdocs.yml の nav に追加した（必要な場合）
• [ ] ローカルで uv run mkdocs build --strict が通る