Skip to content

docs-dev ディレクトリ構成ルール

1. 目的

  • 公開対象ドキュメントを検索不要で到達できる状態に保つ
  • 恒久ドキュメントと一時メモを分離する

2. 公開対象と非公開対象

公開対象:

  • commands/, scripts/ と主要技術ガイド(root 直下のガイド群)

非公開対象:

  • README.md, SECURITY.md, GEMINI.md, agent-workflows/ 配下
  • 一時分析メモ (analyze-support-guide.md, codebase-analysis.md など)

3. 導線ルール

公開対象を追加・更新した場合は、同じ変更で次を更新する。

  1. .vitepress/config.tssidebar
  2. index.md の Quick Links

4. 一時資料の扱い

  • 一時資料は scratch/docs-dev-temporary/ に配置する
  • 恒久化する場合のみ docs-dev に移す

5. チェックリスト

  • [ ] sidebar 登録済み
  • [ ] index.md から到達可能
  • [ ] npm run docs:build が成功

放課後リンク 開発プロジェクト