Communityライティング&編集github.com

docs-system — 文書管理システム

リポジトリに完全な文書管理システム(分類フォルダ+タクソノミ+MEMORIALコンペンディウム)を導入・維持するためのエージェントスキルです。bootstrap/migrate/compile/append の4つのスクリプトで構成されています。

docs-system — 文書管理システム とは?

docs-system は、任意のリポジトリにスケーラブルで統制の取れた文書管理システムを導入するためのエージェントスキルです。このスキルは、4つの冪等なスクリプト(bootstrap, migrate, compile, append)を順に実行することで、文書の分類、インデックス作成、コンペンディウム(MEMORIAL)の生成・更新を自動化します。bootstrap はカテゴリフォルダとガバナンス文書をセットアップし、migrate は既存の文書をタイプ別に分類・移動(git mv で履歴保持)、compile は各フォルダの MEMORIAL.md を日付順に再構築(冪等)、append は README インデックスにリンクを追加します。すべての操作は git で追跡され、--dry-run による事前確認と git revert による安全なロールバックが可能です。Claude Code, Cursor, Codex などのエージェント環境で動作し、`SKILL.md` に基づいた標準ワークフローを提供します。文書を作成・編集した後は必ず compile を実行するルールがエージェント設定ファイルに自動的に書き込まれるため、常に一貫性が保たれます。

対応~Claude Code~Codex CLI~Cursor
npx skills add matheusmlopess/docs-system

Installed? Explore more ライティング&編集 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

docs-system — v1.0.0

任意のリポジトリに完全な文書管理システムをインストールし、維持します。このスキルは、プロジェクトの文書を整理、分類、インデックス化し、同期を保つ必要がある場合、または「文書管理システム / 文書タクソノミ / 文書コンペンディウムをセットアップして」と依頼された場合に使用します。

このスキルは4つのスクリプト(scripts/ 内)で実装されています。順番に呼び出します。すべて冪等で、履歴を保持します(git mv)。移行はレビュー可能です(最初に --dry-run)。


使用するタイミング

  • リポジトリに未分類の文書が散在している → システムをインストールし、それらを移行します。
  • 文書を作成・編集した → そのフォルダのコンペンディウムを再生成します(必須手順)。
  • 文書インデックス/用語集/「MEMORIAL」/タクソノミを求められた場合。

コマンド(スクリプト)

コマンドスクリプト目的
bootstrapscripts/docs-bootstrap.sh <repo>キットをインストール:カテゴリフォルダをスキャフォールド、ガバナンス文書(タクソノミ/テンプレート/クイックスタート/レジストリ/用語集)をコピー、4つのスクリプトをインストール、エージェントファイルに文書ルールを追加。冪等。
migrate`scripts/docs-migrate.sh [--dry-run--apply] `
compilescripts/docs-compile.sh <folder><folder>/MEMORIAL.md を(再)構築します。すべての文書を日付順に並べたコンペンディウムで、インデックス+用語集リンク+全文を含みます。決定論的な再構築:冪等/自動追記/重複除去/並び替え。--clean <folder> で削除します。
appendscripts/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 — 完全な手順、設定パラメータ、検証、ロールバック。

関連スキル