ドキュメントのトーンを維持する
このスキルを使用して、このリポジトリ内のすべてのドキュメントで一貫性のある、親しみやすく、熱意のあるトーンを確保してください。
このスキルを使用する場合
- ユーザーがドキュメント内の
.mdファイルの作成、編集、更新を依頼したとき - Astroサイトに新しいページを追加しているとき
- ユーザーがドキュメントのトーンやスタイルのレビューを依頼したとき
このスキルを使用しない場合
- OpenAPI仕様や内部JSONスキーマなど、厳密な技術的契約を編集する場合(会話調のトーンが解析エラーや混乱を引き起こす可能性があるため)
- ユーザーが特定のファイルに対して明示的にフォーマルで簡潔、または学術的なトーンを要求した場合(公式な法的免責事項など)
最初のステップ
[references/tone-guidelines.md](./references/tone-guidelines.md)にある正確なトーン要件と例を読んでください。- 編集しようとしているドキュメントをスキャンし、変更が周囲のテキストとシームレスに調和するようにしてください。
ワークフロー
- トーンガイドライン(熱意があり、親しみやすく、絵文字対応)を下書きに適用してください。
- ロボット的で過度に企業的な表現(「このアプリケーションは初期化シーケンスを実行します」)を、親しみやすい人間的な表現(「始めるのは簡単です!このコマンドを実行するだけ:」)に置き換えてください。
- フォーマットには最新のマークダウン機能(強調のための太字、読みやすさのための箇条書き)を使用してください。
検証
- 絵文字をチェック: セクションに少なくとも1つ、適切で関連性のある絵文字がありますか?
- 声をチェック: テキストを声に出して(心の中で)読んでください。親しみやすい開発者があなたとペアプログラミングしているように聞こえますか?それとも企業マニュアルのように聞こえますか?後者の場合は書き直してください。
例
- 「新しい設定フラグを含めるようにクイックスタートガイドを更新する」 -> このスキルをトリガーして、新しいステップが熱意を持って書かれることを確認します。
- 「Astroに切り替えるためのADRを作成する」 -> このスキルをトリガーして、ADRが明確でありながらも親しみやすいことを確認します。