コンテンツにスキップ

04.ロードマップ機能

REQ-PM-1.0: プロジェクトロードマップ機能

1. 機能概要

プロジェクトの中長期的な計画と、各マイルストーンの進捗状況を、単一のMarkdownドキュメント(01_ロードマップ.md)で可視化・管理する機能。

この機能は、プロジェクト関係者全員が、いつでも「今どこにいて、どこに向かっているのか」を共通認識として持てるようにすることを目的とする。

2. 詳細な機能要件

REQ-PM-1.1: マイルストーンベースの構成

  • ロードマップは、GitHubのマイルストーンを基準としたセクションで構成されること。
  • 各セクションには、マイルストーンの目標と、GitHub上のマイルストーンページへのリンクが明記されること。

REQ-PM-1.2: 進捗のリアルタイム表示

  • 各マイルストーンの進捗状況(達成率)が、shields.ioなどを利用したバッジによって、リアルタイムかつ視覚的に表示されること。
  • このバッジは、GitHub上のマイルストーンのIssue消化率と自動で連動すること。

REQ-PM-1.3: タスクの紐付けと可視化

  • 各マイルストーンのセクション内に、そのマイルストーンに紐づくIssue(タスク)の一覧がテーブル形式で表示されること。
  • Issueの一覧には、少なくともIssue番号、タイトル、Issueページへのリンクが含まれること。

REQ-PM-1.4: 手動および自動での更新

  • 01_ロードマップ.mdは、基本的にはgh issue listコマンドなどを利用して、手動で更新できること。
  • 将来的には、GitHub Actionsを利用して、この更新プロセスを自動化する機能も提供されること。(REQ-TOOL-1.0: ナビゲーション自動生成機能などと同様のCLI/CI機能)

3. 非機能要件

NFR-PM-1.1: 可読性

  • ロードマップドキュメントは、エンジニアだけでなく、プロジェクトマネージャーやステークホルダーなど、非技術的なメンバーが見ても、プロジェクトの全体像と進捗が直感的に理解できるレイアウトであること。