Skip to main content

セルフ レビューチェックリスト

まず自分で確認してから、pull request for review を送信します。

レビューのために GitHub Docs チームに変更を送信する前に、以下の一覧を参照して自己レビューを完了してください。

  • コンテンツ設計計画がある場合は、変更内容が計画に記載されているユーザーエクスペリエンスと目標を満たしていることを確認してください。
  • pull request を開いた後、ステージング時に変更を表示して、アーティクルが期待どおりにレンダリングされ、ソースと一致することを確認します。 これは、入力ミス、スタイル ガイドに従っていないコンテンツ、バージョン管理の問題によってレンダリングされないコンテンツなどの問題を特定するのに役立ちます。
  • 技術的な精度に関する変更を確認します。
  • pull request 全体をレビューして、翻訳可能なコンテンツの作成に関する Microsoft のガイダンスに従っていることを確認します。 詳しくは、「翻訳するコンテンツの記述」を参照してください。
  • 文法、スペル、スタイル ガイドへの準拠に関する変更を確認してください。 詳しくは、「スタイル ガイド」を参照してください。
  • 新しいバージョン管理を追加した場合、または既存のバージョン管理に変更を加えた場合は、使用可能な各バージョンの記事を表示しながら、変更が期待どおりに表示されるようにします。
  • pull request に失敗したチェックがある場合は、それらがすべて成功するまでトラブルシューティングを行ってください。