LoginSignup
1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@YushiYamamoto(AIを育てる戦略家 プロドウガ)in株式会社プロドウガ

🚀 アジャイル開発で本当に必要なドキュメント一覧表【2025年版】📝

Posted at

こんにちは😊
株式会社プロドウガの@YushiYamamotoです！
らくらくサイトの開発・運営を担当しながら、AI自動化専門のフリーランスエンジニアとしても活動しています❗️

アジャイル開発を始めたばかりの方から「ドキュメントって本当に必要なの？」「何を作ればいいか分からない...」という相談をよく受けます。実際に私も最初は混乱していました💦

今回は、アジャイル開発で本当に必要なドキュメントを一覧表でまとめ、実践的なアドバイスも交えて解説します！

🤔 アジャイル開発でドキュメントは必要なの？

アジャイル開発の誤解を解こう

「アジャイル開発ではドキュメントは不要」という話を聞いたことがありませんか？これは大きな誤解です！1

アジャイル開発では確かに「動くソフトウェア」を重視しますが、ドキュメントを完全に否定しているわけではありません。重要なのは**「目的に応じて必要最小限のドキュメントを作成する」**ことです。

ドキュメント作成の3つの判断基準

ドキュメントを作成するかどうかは、以下の3つの基準で判断しましょう1：

  1. 「何を作るか」の認識合わせに必要か
  2. 途中参加者のキャッチアップを楽にするか
  3. それがあることで開発が楽になるか

この3つの基準のうち、1つでも当てはまればドキュメント作成を検討する価値があります！

📊 アジャイル開発に必要なドキュメント一覧表

A. プロジェクト管理・計画系（必須）

優先度 ドキュメント名 管理ツール 概要
⭐⭐⭐ ユーザーストーリー Jira, Notion, Trello 「誰が・何のために・何をしたいか」を定義
⭐⭐⭐ プロダクトバックログ Jira, Azure DevOps 開発機能の優先順位付きリスト
⭐⭐ スプリント計画書 Jira, Asana 各スプリントの目標とタスク
⭐⭐ レトロスペクティブ記録 Miro, FunRetro 振り返りの結果と改善アクション

B. 要件・設計系（開発効率化）

優先度 ドキュメント名 管理ツール 概要
⭐⭐⭐ 要件定義書 Confluence, Notion ユーザーストーリーの具体的な要件
⭐⭐ システム構成図 draw.io, Lucidchart アーキテクチャ全体の可視化
⭐⭐ ER図 MySQL Workbench データベース設計とリレーション
⭐⭐ API仕様書 Swagger, OpenAPI APIの機能と利用方法
⭐ 画面仕様書 Figma, Adobe XD UI/UXデザインと操作仕様

C. 開発・運用系（品質保証）

優先度 ドキュメント名 管理ツール 概要
⭐⭐ 意思決定記録（ADR） GitHub Wiki 重要な技術決定の理由と経緯
⭐⭐ コーディング規約 GitHub, Markdown コードの品質と一貫性を保つルール
⭐ テスト仕様書 TestRail, Sheets テスト項目と期待結果
⭐ 運用手順書 Confluence 障害対応とメンテナンス手順

D. ステークホルダー向け（コミュニケーション）

優先度 ドキュメント名 管理ツール 概要
⭐⭐ 進捗レポート PowerPoint, Slides クライアントへの状況報告
⭐ ユーザーマニュアル Notion, Confluence エンドユーザー向け操作説明

🎯 各ドキュメントの作成ポイント

1. ユーザーストーリー

最も重要なドキュメントです2。以下の形式で記述します：

# ユーザーストーリー例
**As a** ネットショップの管理者
**I want** 商品の在庫数を一覧で確認したい
**So that** 売り切れ商品を早期に発見できる

## 受け入れ条件
- [ ] 在庫数が10以下の商品は赤色で表示される
- [ ] 在庫数が0の商品は「売り切れ」と表示される
- [ ] 一覧は商品名順でソートされる

2. システム構成図

新しいメンバーが参加した際のキャッチアップに重要です1：

3. 意思決定記録（ADR）

なぜその技術を選んだのかを記録する重要なドキュメントです：

ADRテンプレート例 
# ADR-001: フロントエンドフレームワークの選択

## 状況
新しいWebアプリケーションのフロントエンド開発において、
フレームワークを選択する必要がある。

## 決定
React.jsを採用する。

## 理由
1. チームメンバーのスキルセットと一致
2. 豊富なライブラリとコミュニティサポート
3. TypeScriptとの相性が良い
4. 採用企業が多く、転職市場でも有利

## 結果
- 開発効率の向上
- メンテナンス性の確保
- チームの技術的成長

## 日付
2025-01-15

🚫 作成すべきでないドキュメント

以下のドキュメントはアジャイル開発では避けるべきです1：

❌ 詳細設計書

  • ソースコードを読めば分かる内容
  • メンテナンスコストが高い
  • 頻繁に変更が発生する

❌ 過度に詳細な技術仕様書

  • 実際のコードと乖離しやすい
  • 更新が追いつかない

重要： ドキュメントのメンテナンスコストを常に意識しましょう。更新されないドキュメントは害悪になります。

💡 実践的なドキュメント作成のコツ

1. テキストファイルから始める

最初はメモ書き感覚で始めましょう3：

# プロジェクトルートにdocsディレクトリを作成
mkdir docs
cd docs

# 簡単なマークダウンファイルを作成
touch user-stories.md
touch system-architecture.md
touch api-specs.md

2. バージョン管理を活用

ドキュメントもソースコードと同じように管理しましょう：

# ドキュメントの変更をコミット
git add docs/
git commit -m "feat: ユーザーストーリーを追加"

# レビュープロセスも導入
git checkout -b feature/update-api-docs

3. 自動生成を活用

API仕様書などは自動生成がおすすめです：

FastAPIでのAPI仕様書自動生成例 
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI(
    title="商品管理API",
    description="ECサイトの商品管理システム",
    version="1.0.0"
)

class Product(BaseModel):
    name: str
    price: int
    stock: int

@app.get("/products", response_model=list[Product])
async def get_products():
    """商品一覧を取得"""
    return [
        {"name": "商品A", "price": 1000, "stock": 5},
        {"name": "商品B", "price": 2000, "stock": 0}
    ]

# http://localhost:8000/docs で自動生成されたAPI仕様書を確認可能

🛠️ おすすめのツールと管理方法

ドキュメント管理ツール比較

ツール 特徴 料金 おすすめ用途
Notion 多機能、直感的 無料〜 統合管理
Confluence 企業向け、高機能 有料 大規模チーム
GitHub Wiki コードと連携 無料 技術文書
Miro 視覚的、コラボ 無料〜 図解・ワークショップ

私のおすすめ構成

project/
├── docs/
│   ├── user-stories/
│   ├── architecture/
│   ├── api-specs/
│   └── adr/
├── src/
└── README.md

📈 ドキュメントの効果測定

以下の指標でドキュメントの効果を測定しましょう：

  • 新メンバーのオンボーディング時間
  • 開発中の質問回数
  • バグの発生率
  • 仕様変更による影響範囲

実体験から： 適切なドキュメントがあることで、新メンバーのキャッチアップ時間が70%短縮されました！

🎉 まとめ

アジャイル開発でのドキュメント作成は**「必要最小限で最大の効果」**を目指しましょう！

重要なポイント

  1. ユーザーストーリーと要件定義書は必須
  2. システム構成図とER図で全体像を共有
  3. 意思決定記録（ADR） で将来の自分たちを救う
  4. 詳細設計書は基本的に不要
  5. メンテナンスコストを常に意識する

アジャイル開発の成功は、適切なドキュメントによるチーム間のコミュニケーション向上にかかっています。まずは小さく始めて、チームに合った形を見つけていきましょう！

皆さんのプロジェクトでも、ぜひこの一覧表を参考にしてみてください🚀

最後に：業務委託のご相談を承ります

私は業務委託エンジニアとしてWEB制作やシステム開発を請け負っています。最新技術を活用したレスポンシブなWebサイト制作、インタラクティブなアプリケーション開発、API連携など幅広いご要望に対応可能です。

「課題解決に向けた即戦力が欲しい」「高品質なWeb制作を依頼したい」という方は、お気軽にご相談ください。一緒にビジネスの成長を目指しましょう！

GitHub ポートフォリオ Qiita Codepen
株式会社プロドウガ らくらくサイト

  1. https://ripurun.com/media/agile-development/documents/ ↩ ↩2 ↩3 ↩4

  2. https://sun-asterisk.com/service/development/topics/agile/1472/ ↩

  3. https://biz.moneyforward.com/work-efficiency/basic/9089/ ↩

1
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?