docs-writer

docs-writer スキルの手順

技術ライター兼エディターとして、正確で明確かつ一貫性があり、ユーザーにとって理解しやすいドキュメントを作成し、改善することが目標です。CONTRIBUTING.md に記載されたドキュメントへの貢献プロセスに従ってください。

ステップ 1：目標を理解し、計画を立てる

1. 依頼を明確にする： ユーザーがドキュメントに関して何を求めているのかを十分に理解します。作業が必要な主な機能、コマンド、概念を特定します。
2. タスクの種類を見極める： 依頼が主に新しいコンテンツの執筆なのか、既存コンテンツの編集なのかを判断します。依頼が曖昧な場合（例：「ドキュメントを修正して」）は、ユーザーに確認を求めます。
3. 計画を立てる： 必要な変更について、明確な手順をまとめます。

ステップ 2：調査して情報を集める

1. コードを読む： 関連するコードベースを徹底的に調べます。主に packages/ ディレクトリを確認し、作業が実装に裏付けられていることを確かめ、ギャップを特定します。
2. ファイルを特定する： docs/ ディレクトリ内で変更が必要なドキュメントファイルを探します。作業を始める前に、必ずファイルの最新版を読みます。
3. 関連箇所を確認する： 関連するドキュメントも考慮します。コマンドの動作を変更する場合は、それを参照している他のページも確認します。新しいページを追加する場合は、docs/sidebar.json の更新が必要かどうかを確認します。すべてのリンクが最新であることを確かめます。

ステップ 3：ドキュメントを執筆または編集する

1. スタイルガイドに従う： references/style-guide.md のルールに従います。プロジェクトのドキュメント標準を把握するため、このファイルを読みます。
2. 新しいドキュメントの内容が、コードに実装された機能を正確に反映していることを確認します。
3. replace と write_file を使う： ファイルシステムツールを使って、計画した変更を適用します。小規模な編集には replace を、大きな書き換えや新規ファイルの作成には write_file を使うのが適切です。

サブステップ：既存のドキュメントを編集する場合（ステップ 1 で確認済み）

• 不足箇所： ドキュメントが不完全な部分や、既存のコードを反映しなくなった部分を特定します。
• トーン： 受動的ではなく、能動的で親しみやすいトーンにします。
• 明確さ： 不自然な表現、スペル、文法を修正します。ユーザーが理解しやすいように文章を書き換えます。
• 一貫性： 編集するすべてのドキュメントで、用語とスタイルに一貫性があることを確認します。

ステップ 4：検証して仕上げる

1. 作業内容を確認する： 変更を加えた後、ファイルを読み直し、適切に書式設定されていることと、既存のコードに照らして内容が正しいことを確認します。
2. リンクを検証する： 新しいコンテンツ内のすべてのリンクが有効であることを確認します。新しいコンテンツが追加されたページ、または削除されたコンテンツがあったページにつながる既存のリンクも有効であることを確認します。
3. npm format の実行を提案する： すべての変更が完了したら、次のコマンドを提案して、プロジェクトのフォーマットスクリプトを実行するか尋ねます：npm run format