ns-docs-writer について
ns-docs-writerは、docs/やREADMEの作成・保守を支援するスキルです。開発者、運用担当者、エンドユーザー向けの文書を対象とし、既存資料の確認から対象読者の選定、構成、執筆、リンクまでを進めます。
主な機能
- 01READMEとdocsの執筆
- 02既存文書と対象範囲の確認
- 03読者の選定と構成案の作成
- 04スタイルガイドに沿った執筆
- 05規範文書へのリンク
活用シーン
- 01提供済み機能の文書化
- 02構成変更後のREADME更新
- 03コントリビューター向け導入ガイドの作成
- 04分散したメモのdocs/への整理
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/ns-docs-writerを入力して読み込まれたか確認します。
同梱ファイルevals/evals.jsonreferences/style-guide.md
詳細
ドキュメントライター
docs/ と README ファイルに、明確で保守しやすいプロジェクトドキュメントを作成します。
セッションの開始
../../ns-harness/references/session-boot.md を参照してください。
対象範囲
| 対象範囲内 | 対象範囲外 |
|---|---|
プロダクトまたはリポジトリのルートにある README.md | インラインの // または /** コードコメント |
docs/**/*.md のガイド | docs/versions/*/sdd/requirements.md、docs/versions/*/requirements.md（レガシー SDD） |
| 人間向けの運用手順書、インストールガイド、アーキテクチャ概要 | docs/specs/ の更新され続ける仕様書（ns-living-spec を使用） |
| 依頼された場合の変更履歴 | リポジトリ外のマーケティング文 |
使用するタイミング
- 新機能にユーザー向けまたは開発者向けのドキュメントが必要な場合
- 構造の変更後に README が古くなった場合
- コントリビューター向けオンボーディングガイド
- 散在するメモを
docs/に集約する場合
ワークフロー
- 調査 — 既存の
docs/、README、AGENTS.mdのリンクを一覧にし、ハーネスや既存コードベースの成果物との重複を避けます（リンクで参照します）。 - 対象読者 — 開発者、運用担当者、エンドユーザーのいずれかを確認します（デフォルト：開発者）。
- 構成 — 長いガイドを執筆する前に、簡潔な目次を作成します。
- 草稿 —
references/style-guide.mdに従います。 - リンク — 相対リンクを優先し、該当する場合は
.nextstage-harness/rules/の正式なルールを参照します。
レイアウト（スタックに依存しない）
モノレポの packages/ レイアウトを前提にしないでください。以下をもとに判断します。
AGENTS.mdのレイアウト表architecture-rules.md- 既存の
docs/構成
プロジェクトの慣例に合う場合に限り、サブフォルダーを作成します。
統合
ns-spec-driven から呼び出された場合は、提供済みの動作を記述し、要件を作り上げないでください。
エージェントの理由（リファレンスアーキテクチャ、エージェントとコードの比較、トレードオフ、トポロジー、HITL、変更の兆候）は docs/specs/agent-architecture.md に記載されています。これにリンクしてください。README にインタビューの内容をコピーしたり、意思決定記録を書き直したりしないでください。docs/specs/agent.md は動作を記述するものであり（ns-living-spec）、この ADR ではありません。
禁止事項
brownfield-map.mdまたはsystem-reverse-spec.mdの全文を新しいドキュメントにコピーすること（リンクで参照してください）- プロジェクトで英語のドキュメントが義務付けられている場合に、英語以外で記述すること
- まだ存在しないコードのドキュメントを自動生成すること
- 同じバージョンに
docs/versions/*/sdd/requirements.mdとレガシーのdocs/versions/*/requirements.mdの両方を置くこと — 正式なsdd/パスだけにリンクし、二重のツリーを作成または保守しないでください
コメント
Markdown 対応