doc-writer

ドキュメントライター

プロジェクトの適切な構成に沿って技術文書を作成するためのスキルです。

作成プロセス

ステップ 1：既存のドキュメント構成を確認する

docs/ とそのサブフォルダーが存在するか確認します。

ステップ 2：カテゴリを決定する

docs/ にサブフォルダーがある場合：選択肢として提示します。

サブフォルダーがない場合、ユーザーに尋ねます：

カテゴリ	用途
specs/	機能やシステムの仕様
planning/	実施中の実装計画
archive/	完了済み、または後継の文書に置き換えられた文書
architecture/	ADR、アーキテクチャ上の決定
reference/	技術リファレンスドキュメント
backlog/	保留中の機能、今後のアイデア
work-in-progress/	作業中のドキュメント

ステップ 3：ファイル名を生成する

形式：YYYY-MM-DD-<feature-name>.md

• 現在の日付を使用します（時刻なし）
• <feature-name> は説明的な kebab-case とし、スペースは使用しません
• 例外：ADR では NNNN-<name>.md を使用します（連番）

ステップ 4：ドキュメントを作成する

1. サブフォルダーが存在しない場合は作成します
2. references/ の該当するテンプレートを読み、適用します：
   • 仕様：references/spec-template.md
   • 計画：references/plan-template.md
   • ADR：references/adr-template.md
   • リファレンス：references/reference-template.md
3. 正しい場所にファイルを作成します

リソース

各種ドキュメントの完全な例を見るには、references/ 内のファイルを読んでください：

種類	テンプレート	例
仕様	references/spec-template.md	references/spec-example.md
計画	references/plan-template.md	references/plan-example.md
ADR	references/adr-template.md	references/adr-example.md
リファレンス	references/reference-template.md	references/reference-example.md