mcpField
S
specsfy-documentator

specsfy-documentator

github.com/promovaweb開発87440 回インストール1 週間前に更新
リポジトリ

specsfy-documentator について

specsfy-documentatorは、技術ドキュメントを整備するチーム向けのSpecsfyスキルです。ローカルのコードとメタデータからドキュメントとパッケージ一覧を生成し、現在のプロジェクト状態との一致を検査します。

主な機能

  1. 01アーキテクチャとコンポーネントの文書化
  2. 02アプリケーション、データベース、フローの整理
  3. 03テスト、フロントエンド、連携情報の記録
  4. 04npmとComposerのパッケージ一覧作成
  5. 05文書とプロジェクト状態の照合

活用シーン

  1. 01既存コードベースの技術文書を作成
  2. 02ローカルメタデータに基づく依存関係の一覧化
  3. 03文書が現在のコードを反映するか確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/promovaweb/specsfy --skill specsfy-documentator

インストール後、Claude Code で/specsfy-documentatorを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

agents/
openai.yaml
references/
documentation-standard.md
scripts/
build_documentation.mjs

詳細

システムをドキュメント化する

必須の準備

このスキルを実行する前に、プロジェクトのルートで $specsfy-setup を必ず読み込んでください。自動ハンドオフの場合は、この段階の前にもう一度読み込んでください。会話で確認済みのルートを再利用し、セットアップで未対応事項が示された場合は先に進まないでください。

対話モード

対話モード：質問なし。 このスキルでは質問をしないでください。実行可能なソースで裏付けられないデータは、すべて「未特定」として記録してください。

  1. ローカルの指示、PROJECT.md、.specsfy/STACK.md、 .specsfy/RULES.md、.specsfy/DATABASE.md、マニフェスト、ロックファイル、 インストール済みのメタデータ、既存のコードを読み込みます。

  2. 公開済みトポロジーを変更する前に、ドキュメント標準を読み込みます。

  3. スペックや直近の実装なしでスキルが起動された場合も含め、ドキュメント全体と .specsfy/PACKAGES.md を構築します。

    node scripts/build_documentation.mjs --project <raiz>

  4. 生成されたファイルを調査し、コードで裏付けられない推論のみを手動で修正します。決定事項、関係、連携を捏造しないでください。

  5. ドキュメントが現在の状態を表していることを証明するため、--check を実行します。

    node scripts/build_documentation.mjs --project <raiz> --check

  6. .specsfy/PACKAGES.md も含め、specsfy:documentator ブロックの外にある人手による内容を保持します。このブロックは、ローカルソースから再構築可能な投影として扱います。

  7. タスクのエビデンスに、コマンド、結果、更新したファイルを記録します。

必須のカバレッジ

docs/ に以下を維持します。

  • ポータルと読み進める順序
  • アーキテクチャ、コンポーネント、Mermaid による UML
  • アプリケーションのインベントリと既存の実装
  • データベースと erDiagram によるエンティティ
  • flowchart と sequenceDiagram によるフロー
  • テストガイドとテストの概要
  • フロントエンド、ビュー、React、Tailwind
  • ネイティブ、フレームワーク、統合、サードパーティのライブラリとパッケージ。バージョン、ソース、GitHub の参照先を含めます。
  • 機密値を含まない連携と設定変数
  • 明示された決定事項とそのソース

.specsfy/PACKAGES.md に以下を維持します。

  • プロジェクトのマニフェストとロックファイルで見つかった、推移的依存関係としてローカルに記録されたものも含むすべての npm および Composer パッケージ
  • 各パッケージのパッケージマネージャー、スコープ、名前、バージョン、簡潔な用途、ソース
  • ロックファイルまたはインストール済みパッケージに宣言された説明がある場合、その説明
  • ローカルメタデータで用途を確認できない場合は、その旨を明示する警告

Laravel の場合は、ルート、コントローラー、モデル、サービス、ジョブ、ポリシー、Blade、マイグレーション、Pest/PHPUnit をマッピングします。Node、Next.js、React、Astro の場合は、ページ、API ルート、コンポーネント、モジュール、スクリプト、Vitest/Jest/Node Test をマッピングします。

制限事項

  • シークレット、.env の値、本番データ、コード全体をコピーしないでください。
  • ヒューリスティックを確認済みの決定事項として提示しないでください。
  • スペック、PROJECT.md、.specsfy/ 内の人手によるファイルを置き換えないでください。このディレクトリでスキルが再構築する唯一の投影は PACKAGES.md であり、生成ブロック外の内容は保持します。
  • 構築にネットワークを必要としないでください。パッケージの GitHub リポジトリがローカルに宣言されておらず、既知でもない場合は、URL を捏造せず、検索結果であることを明示して GitHub 検索を掲載してください。

コメント

Markdown 対応