docs-system — v1.0.0
任意のリポジトリに完全な文書管理システムをインストールし、維持します。このスキルは、プロジェクトの文書を整理、分類、インデックス化し、同期を保つ必要がある場合、または「文書管理システム / 文書タクソノミ / 文書コンペンディウムをセットアップして」と依頼された場合に使用します。
このスキルは4つのスクリプト(scripts/ 内)で実装されています。順番に呼び出します。すべて冪等で、履歴を保持します(git mv)。移行はレビュー可能です(最初に --dry-run)。
使用するタイミング
- リポジトリに未分類の文書が散在している → システムをインストールし、それらを移行します。
- 文書を作成・編集した → そのフォルダのコンペンディウムを再生成します(必須手順)。
- 文書インデックス/用語集/「MEMORIAL」/タクソノミを求められた場合。
コマンド(スクリプト)
| コマンド | スクリプト | 目的 |
|---|---|---|
| bootstrap | scripts/docs-bootstrap.sh <repo> | キットをインストール:カテゴリフォルダをスキャフォールド、ガバナンス文書(タクソノミ/テンプレート/クイックスタート/レジストリ/用語集)をコピー、4つのスクリプトをインストール、エージェントファイルに文書ルールを追加。冪等。 |
| migrate | `scripts/docs-migrate.sh [--dry-run | --apply] ` |
| compile | scripts/docs-compile.sh <folder> | <folder>/MEMORIAL.md を(再)構築します。すべての文書を日付順に並べたコンペンディウムで、インデックス+用語集リンク+全文を含みます。決定論的な再構築:冪等/自動追記/重複除去/並び替え。--clean <folder> で削除します。 |
| append | scripts/docs-append.sh <doc> ["summary"] | 文書のリンク行を、そのフォルダの README.md インデックスに追加します(冪等)。 |
標準ワークフロー
# 1. 設定(リポジトリごとに1回)
cp docs-system.conf.example .docs-system.conf # PROJECT_NAME, AGENT_RULES, PLAN_BUCKET を編集
# 2. インストール
scripts/docs-bootstrap.sh .
# 3. 既存文書の移行 — 最初に DRY-RUN、レビュー後 apply
scripts/docs-migrate.sh --dry-run .
scripts/docs-migrate.sh --apply .
# 4. コンペンディウムを構築
for d in documentation features testing reviews changes PLANS; do
scripts/docs-compile.sh "docs/$d"
done
# 5. 仕上げ:docs/documentation/DOCUMENTATION-REGISTRY.md を再シード、GLOSSARY.md のプロジェクト用語を編集
必須の継続ルール
docs/<folder>/ 配下で文書を作成または編集した後は、必ず
scripts/docs-compile.sh docs/<folder> を実行し、再生成された MEMORIAL.md を文書と一緒にコミットしてください。
MEMORIAL.md は手動編集しないでください(自動生成です)。このルールは bootstrap によってターゲットリポジトリのエージェントルールファイルにも書き込まれます。
文書ヘッダーマーカー(強制)
すべての .md は H1 の下に以下を持ちます。
<!-- version --> · <!-- classification: TYPE --> · <!-- date --> · <!-- last-updated -->。
date は作成時に1回設定され、last-updated のみ編集時に変更されます。タイプ:
FEATURE / TESTING / DESIGN / GAPS / ANALYSIS / CHANGE / STUDY / REVIEW / ARCHITECTURE / SUMMARY / PLAN。
安全性/ロールバック
docs-migrate.shはデフォルトで--dry-runになります。--applyの前に表を確認してください。- コンペンディウムの復元:
scripts/docs-compile.sh --clean docs/<folder>またはfind docs -name MEMORIAL.md -delete。 - すべて git で追跡されています。
git revertで実行を元に戻せます。移動は名前変更です(履歴保持)。
参考
references/PLAYBOOK.md— 完全な手順、設定パラメータ、検証、ロールバック。