| name | reviewer |
| description | ASP.NET Core ハンドブックの記事をレビューする。Use when: 記事をレビューする、ドキュメントを校正する、コードレビューする、PRをレビューする。技術ドキュメントのレビュー、品質チェック、校正。 |
| argument-hint | レビュー対象のファイルパスまたは変更差分を指定 |
ASP.NET Core ハンドブック レビュースキル
概要
このスキルは、docs/ フォルダ内のマークダウンドキュメントをレビューするためのチェックリストとガイドラインです。
対象読者は C# 以外の言語経験者 であり、日本語で記述されたドキュメントを対象とします。
レビュー手順
1. 日本語表記
- 日本語の誤字・脱字を指摘してください。
- カタカナ表記ゆれを
.github/instructions/katakana.instructions.md の辞書に基づいて指摘してください。
2. 技術的正確性
- ASP.NET Core / .NET の API 名やクラス名が正しいか MS Learn を確認してください。
- コードサンプルのシンタックスが正しいか確認してください。
- コードサンプルが確実に動作するか、想定通りの結果となるか実際に実装してテストしてください。実装が存在する場合はテストを実行してください。
- 公式ドキュメントの URL が正しい形式か確認してください。
- ASP.NET Core 関連の URL は
?view=aspnetcore-N.0(N は .github/instructions/versioning.instructions.md のバージョン決定ルールで決定した番号)を含むこと。
- マークダウン取得: URL に
&accept=text/markdown を付与して curl で取得するとノイズが少なく根拠抽出しやすい。
- ロケール運用: 情報収集時は
en-us の URL を使用し、ドキュメント内の参考リンクとして記載する際は ja-jp の URL を使用していること。
- バージョン情報が
.github/instructions/versioning.instructions.md のバージョン決定ルールと整合しているか確認してください。
3. マークダウン構文
- リンクの記法
[テキスト](URL) が正しいか確認してください。
- コードブロックの言語指定(
csharp, xml, json, bash, text など)が適切か確認してください。
- テーブルの列数が揃っているか確認してください。
- 目次のアンカーリンクが見出しと一致しているか確認してください。
- Mermaid 図が正しい構文で記述されているか確認してください。
> [!TIP] / > [!NOTE] / > [!WARNING] の使い分けが適切か確認してください。
4. 対象読者への配慮
- 対象読者(C# 以外の言語経験者)にとって丁寧な表現かつ内容になっているか確認してください。
.github/skills/languages.md に記載の言語・フレームワークとの比較説明が正確か確認してください。
5. ドキュメント構造
writer スキルで定義された形式ルール(見出し階層、目次、前後リンクなど)に準拠しているか確認してください。
レビュー結果の出力形式
レビュー結果は以下のカテゴリに分けて報告してください。
| カテゴリ | 説明 |
|---|
| 🔴 誤り | 技術的な間違い、リンク切れ、構文エラーなど修正必須の指摘 |
| 🟡 改善提案 | 表記ゆれ、わかりにくい表現、構成の改善など推奨の指摘 |
| 🟢 良い点 | 特に優れている箇所のフィードバック |