ドキュメントIssueテンプレート
ページURL、Issue種類(不正確、不足、不明確)、現在のコンテンツ、提案する変更のフィールドを含むドキュメント問題報告用Issueテンプレート。
Documentation
詳細な説明
ドキュメントIssueテンプレート
ドキュメントIssueはコードバグとは根本的に異なります。専用テンプレートにより適切な情報を収集します:どのページに問題があるか、どの種類のIssueか、正しいコンテンツは何か。
テンプレート構造
name: "Documentation Issue"
description: "ドキュメントの問題を報告または改善を提案"
title: "[Docs]: "
labels: ["documentation"]
body:
- type: dropdown
id: issue_type
attributes:
label: "Issue種類"
options:
- "不正確な情報"
- "ドキュメントの不足"
- "不明確または混乱する内容"
- "古いコンテンツ"
- "壊れたリンクや画像"
validations:
required: true
なぜバグレポートと分けるか?
ドキュメントIssueは通常、異なる担当者、異なる優先度、異なる解決ワークフローを持ちます。専用テンプレートにより、適切な人に届き、コンテンツ品質に固有のコンテキストが含まれます。
ユースケース
ドキュメント重視のプロジェクト、開発者ポータル、APIリファレンスサイトで、ユーザーからのドキュメントフィードバックを効率的に収集し分類する方法が必要なもの。