specsfy-monorepo-documentator について
Specsfy monorepo のユーザー向け・技術ドキュメントを保守するコントリビューター向けのスキルです。根拠に基づく記述と指定の読解手順を重視し、ユーザー文書の変更後は電子書籍成果物を再生成します。
主な機能
- 01編集前の monorepo 証拠収集
- 02リポジトリとモジュールの指示に従う
- 03根拠資料に照らした記述の確認
- 04ユーザー向け文書と技術文書の保守
- 05ユーザー文書変更後の PDF、EPUB、マニフェスト再生成
- 06テスト、状態、差分の確認
活用シーン
- 01アーキテクチャやモジュール変更の文書化
- 02公式ユーザーガイドと技術文書の同時更新
- 03現行コードとテストに基づく文書監査
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ promovaweb/ specsfy --skill specsfy-monorepo-documentatorインストール後、Claude Code で/specsfy-monorepo-documentatorを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
agents/openai.yamlreferences/documentation-standard.mdscripts/collect_monorepo_evidence.py詳細
Specsfy モノレポを文書化する
- ルートで実行します:
python3 -B \
.agents/skills/specsfy-monorepo-documentator/scripts/collect_monorepo_evidence.py \
--workspace .
- コレクターから、ディレクトリが公式モノレポを表していないと報告された場合は中止します。
- ルートの
AGENTS.mdと、影響を受けるモジュールの指示をすべて読みます。 docs/develop/context/README.mdと、変更によって指定されたコンテキストのみを読みます。- トポロジー、分類、閲覧順序を編集する前に、文書化の標準を読みます。
- 各記述を、担当モジュールのコード、テスト、マニフェスト、設定、スキーマ、運用文書または規範コンテキストと照合します。
- 変更がアーキテクチャと使い方の両方に及ぶ場合は、両方の文書を更新します:
docs/user/のユーザー向け文書。docs/develop/の技術文書。docs/user/installation.mdを正式なインストールガイドとして維持し、基本スキルごとにdocs/user/skills/にページを用意します。docs/user/reading-order.txtの学習順序は一貫性を保ち、メソッド、インストール、初回の成果物、基本フロー、運用、高度な使い方の順にします。
- モジュール間では相対リンクを使用します。公開 URL には
https://github.com/promovaweb/specsfyを使用します。 docs/user/を変更した後は、必ずバージョン管理に追加し、make ebookで PDF、EPUB、マニフェストを再生成します。- 各モジュールの焦点を絞ったテストと統合回帰テストを実行し、モノレポ全体で単一のステータスと差分を確認します。
エビデンスに関するポリシー
- 現在の情報源で確認できる内容のみを事実として記録します。
- 現行の決定、実装済みの状態、推論、未解決事項を区別します。
- 情報源に食い違いがある場合は、確認された状態をそのまま維持します。
- マニフェスト、ルート、スキーマ、テストから導き出した大量の一覧を複製しません。
- 目的がない限り、シークレット、本番データ、内部コンテンツを複製しません。
- ルートに
plan.md、tasks.md、research.md、data-model.md、specs/を作成しません。
利用者向けドキュメント作成ツールとの境界
このスキルでは、モノレポの方法論、アーキテクチャ、公式ガイドを文書化します。利用者アプリケーションの <projeto>/docs/ については、$specsfy-documentator を読み込みます。
ローカルでの排他性
- ソースは
.agents/skills/specsfy-monorepo-documentator/のみに置きます。 - シンボリックリンク
.claude/skills/specsfy-monorepo-documentatorを使って、Claude に同じソースを公開します。 skills/に同名のスキルを作成したり、インストーラーに含めたりしません。- 監査のみを求められた場合は、情報を収集して読むだけにとどめ、ファイルを公開しません。
コメント
Markdown 対応