docs-agile-integration

ドキュメントとアジャイルの統合

このスキルを使って、ドキュメント固有の作業を見えなくすることなく、アジャイルな製品開発にドキュメントを統合します。製品の意思決定が行われるサイクルに合わせて、ドキュメントの計画、レビュー、リリース準備、保守をライターと製品チームが進められるよう支援します。

このスキルは、Christopher Gales と Splunk Documentation Team による The Product Is Docs: Writing Technical Documentation in a Product Development Group のガイダンスを言い換えて作成したものです。特に、第 2 章「Agile」、第 19 章「Working with Engineers」、第 22 章「Working with Product Management」、第 23 章「Working on a Remote Team」を参考にしています。書籍の文章をユーザー向けの出力にコピーしないでください。出典：https://link.springer.com/book/10.1007/978-1-4842-7217-6

クイックスタート

1. guidelines.md を読み込み、役に立つ最小限の参考資料セットを選びます。
2. チームのアジャイルサイクル、計画用の成果物、リリースモデル、ドキュメントの作業が現在見えなくなっている場所を特定します。
3. workflows/integrate-docs-agile.md を使って、ドキュメント作業を製品作業に結び付けます。
4. workflows/define-docs-done.md を使って、完了の定義またはリリース準備にドキュメントのチェック項目を追加します。
5. 機能スプリント向けのドキュメント作業と、正当にスプリントやチームをまたぐドキュメント作業を分けます。
6. 推奨するボードの変更、ドキュメントのタスク、レビューチェックポイント、ブロッカー、ふりかえりのシグナルを提示します。

デフォルトの出力

ドキュメントをアジャイル作業に統合する際は、次の内容を提示します。

1. 現在のプロセスマップ - サイクル、成果物、ボード、役割、リリースゲート、レビューパス。
2. ドキュメントの可視性に関する不足 - ドキュメントの影響、タスク、ブロッカー、レビュー、リリース準備が不足している箇所。
3. 推奨ワークフロー - チケットとリンクのモデル、計画チェックポイント、担当者、レビューのタイミング。
4. 完了の定義の更新 - ドキュメントへの影響、ドラフト、レビュー、QA、公開、リリースノート、保守のチェック。
5. スプリントをまたぐ作業の扱い - シナリオ、保守、IA、チーム横断のドキュメントを、単一スプリントに無理に当てはめず、見える状態に保つ方法。
6. 検査と適応のシグナル - サポートからのフィードバック、レビュー漏れ、遅れたドキュメント、古くなったコンテンツ、ふりかえりでのアクション。

目次

必要な内容	まず確認する場所
ドキュメントとアジャイルの概念を理解する	references/core/knowledge.md
計画とボードにドキュメントを統合する	workflows/integrate-docs-agile.md
ドキュメントの完了とリリース準備を定義する	workflows/define-docs-done.md
タスクや兆候に応じて確認先を選ぶ	guidelines.md

基本方針

• ドキュメントを製品作業として扱います。
• 製品チームがすでに使っている計画システムで、ドキュメントを見える状態にします。
• すべてのドキュメント作業を無理に 1 つのスプリントに収めるのではなく、実際のスコープに合わせてドキュメントのサイクルを調整します。
• リリースリスクが顕在化する前に、負担の少ないチェックポイントを追加します。
• ふりかえりと顧客からのシグナルを活用して、プロセスを改善します。