mcpField
W
w-docs

w-docs

github.com/blockmatic開発1647 回インストール4 週間前に更新
リポジトリ

w-docs について

w-docs は、コード変更に合わせて文書を更新するリポジトリ向けスキルです。既存の文書レイヤーを使い分け、情報の重複を避けます。

主な機能

  1. 01該当する文書セクションの選定
  2. 02正本となる MDX トピックページの更新
  3. 03README をセットアップと実行情報に限定
  4. 04制約変更時のみエージェントルールを更新
  5. 05依頼のないファイル移動やコミットの回避

活用シーン

  1. 01動作やアーキテクチャの変更記録
  2. 02スクリプト変更に伴うセットアップ手順の更新
  3. 03文書ファイルの移動案の整理

インストール

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

$npx skills add https://github.com/blockmatic/basilic-skills --skill w-docs

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

詳細

現在のコードまたは機能について文書化します。利用側のリポジトリのドキュメントおよび README のルールに従ってください。依頼されない限り、コミットしないでください。長期的に維持する情報設計は既存の MDX に記載し、別のサイトマップを新たに作成しないでください。

変更を担当するレイヤーに記載してください。

レイヤー役割更新するタイミング
技術ドキュメント(AGENTS.md に記載のパス)アーキテクチャ、ADR、ハウツー挙動、アーキテクチャ、コマンド、規約、またはワークフローが変わったとき
エージェントルール簡潔な制約エージェントが遵守すべき規約が変わったとき
最も近い READMEこのアプリ/パッケージの実行方法。リンクのみスクリプト、セットアップ、またはパッケージの用途が変わったとき

コードの内容が誤解を招く場合に限り、インラインコメントを追加してください。MDX をルールや README にコピーしないでください。MDX を @ で添付しないでください。

  1. 該当するドキュメントのセクションを特定し、次に既存のトピックページを特定します(適切なページがない場合に限り、新しいページを作成します)。
  2. 正式な説明に変更があった場合は、MDX を作成または修正します。
  3. README は実行方法/セットアップ/スクリプトに関する場合に限り修正し、MDX へのリンクを記載します。
  4. 制約が変わった場合に限り、glob に一致するルールを修正します。
  5. 機械的なファイル移動やドキュメント移動の場合は、関連ファイルごとにグループ化した、移動元/移動先の最小限の一覧を提案します。グループ内ではフォルダー名の接頭辞を省略します。ユーザーがパスを指定した場合に限り保存します。実装も依頼されていない限り、ファイルを移動しないでください。

コメント