ドキュメント専用プルリクエストテンプレート

ドキュメント専用PRテンプレート

ドキュメントPRはコードPRとは異なる要件があります。コンパイル、ユニットテスト、型チェックは不要です。このテンプレートはドキュメント変更に特化し、不要なチェックリスト項目を減らしつつ、ドキュメント固有の品質チェックを追加しています。

テンプレート構造

## Description
<!-- どのドキュメントが追加/更新されますか？ -->

## Type of Documentation
- [ ] README更新
- [ ] APIドキュメント
- [ ] ユーザーガイド/チュートリアル
- [ ] インラインコードコメント
- [ ] アーキテクチャ決定記録（ADR）
- [ ] 設定ドキュメント

## Checklist
- [ ] スペルと文法をチェック
- [ ] リンクを確認（壊れたリンクなし）
- [ ] コード例をテストし動作確認
- [ ] スクリーンショットが最新
- [ ] 目次を更新（該当する場合）
- [ ] 既存ドキュメントと一貫したフォーマット

別のドキュメントテンプレートが必要な理由

コード重視のテンプレートをドキュメントPRに使うと摩擦が生じます。コントリビューターは「ユニットテストが通過する」などの無関係なチェックリスト項目を頭の中でスキップする必要があります。専用テンプレートによりプロセスがスムーズになります。

ドキュメント固有の品質チェック

• スペルと文法 — 品質の低い文章は信頼性を損なう
• リンク検証 — 壊れたリンクは時間とともにドキュメントの使いやすさを低下させる
• コード例のテスト — 古いコードサンプルはサンプルがないよりも悪い
• スクリーンショットの鮮度 — UIスクリーンショットは製品の進化に伴い古くなる

プレビューリンク

多くのドキュメントシステム（Docusaurus、GitBook、Nextra）はPRのデプロイプレビューを生成します。Previewセクションはコントリビューターにビジュアルレビュー用のプレビューURLを共有するよう促します。