mcpField
N
ns-code-docs-writer

ns-code-docs-writer

github.com/nextstage-brasilドキュメント054 回インストール5 日前に更新
リポジトリ

ns-code-docs-writer について

ns-code-docs-writerは、READMEやdocs/のプロジェクト文書を作成・保守する開発者向けスキルです。既存のガイドラインや文書構成を確認してから、対象読者に合わせて内容を組み立てます。

主な機能

  1. 01READMEとdocs/の文書作成
  2. 02既存文書とプロジェクト指針の確認
  3. 03対象読者に合わせた構成と執筆
  4. 04相対リンクで規則を参照

活用シーン

  1. 01新機能のユーザー向け・開発者向け文書作成
  2. 02構成変更後の古いREADMEの更新
  3. 03コントリビューター向けガイドの整備
  4. 04散在するメモのdocs/への集約

インストール

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

$npx skills add https://github.com/nextstage-brasil/skills --skill ns-code-docs-writer

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

同梱ファイルevals/evals.jsonreferences/style-guide.md

詳細

Docs Writer

docs/ と README ファイルに、明確で保守しやすいプロジェクトドキュメントを作成します。

ハーネスの検出

../ns-harness/references/harness-discovery.md を参照してください。AGENTS.md から {product_root} を解決してください。

対象範囲

対象範囲対象外
プロダクトまたはリポジトリのルートにある README.mdインラインの // または /** コードコメント
docs/**/*.md のガイドdocs/versions/*/requirements.md
人間向けの運用手順書、インストールガイド、アーキテクチャ概要docs/specs/ の更新され続ける仕様書(ns-sdd-living-spec-consolidator を使用してください)
依頼された変更履歴の項目リポジトリ外のマーケティング文書

使用する場面

  • 新機能にユーザー向けまたは開発者向けドキュメントが必要な場合
  • 構造の変更後に README が古くなっている場合
  • コントリビューター向けオンボーディングガイドを作成する場合
  • 散在するメモを docs/ にまとめる場合

ワークフロー

  1. 調査 — 既存の docs/、README、AGENTS.md のリンクを一覧表示し、ハーネスや既存コードベースの成果物との重複を避けます(代わりにリンクします)。
  2. 対象読者 — 開発者、運用担当者、エンドユーザーのどれを対象とするか確認します(既定値:開発者)。
  3. アウトライン — 長いガイドを作成する前に、簡潔な目次を用意します。
  4. 下書き — references/style-guide.md に従います。
  5. リンク — 相対リンクを優先します。該当する場合は .nextstage-harness/rules/ の正式なルールを参照します。

レイアウト(技術スタックに依存しない)

モノレポの packages/ レイアウトを前提にしないでください。次の内容から判断します。

  • AGENTS.md のレイアウト表
  • architecture-rules.md
  • 既存の docs/ 構成

サブフォルダーは、プロジェクトの慣例に合致する場合にのみ作成します。

統合

ns-spec-driven から呼び出された場合は、提供済みの動作を記述し、要件を創作しないでください。

禁止事項

  • brownfield-map.md または system-reverse-spec.md の本文全体を新しいドキュメントにコピーすること(リンクしてください)
  • プロジェクトで英語のドキュメントが必須とされている場合に、それに違反すること
  • まだ存在しないコードのドキュメントを自動生成すること

コメント