執筆ワークフロー

概要

本記事は outline.md に定義された構成に従い、章ごとに執筆と実装を同期しながら進める。

ワークフロー図

詳細フロー

MkDocs 反映ワークフロー

MkDocs 更新手順

1. mkdocs.yml への章追加

nav:
  - 実践データベース設計:
      - 第N部 セクション名:
          - 第N章 章タイトル: article/partN/chapterNN.md

2. ローカルプレビュー

# サーバー起動
mkdocs serve

# ブラウザで確認
# http://localhost:8000

3. ビルド・デプロイ

# 静的サイト生成
mkdocs build

# GitHub Pages へデプロイ（設定済みの場合）
mkdocs gh-deploy

MkDocs チェックリスト

• 章ファイルが正しいパスに配置されている
• mkdocs.yml の nav に章が追加されている
• index.md のリンクが正しい
• ローカルプレビューで表示確認済み
• PlantUML ダイアグラムが正しくレンダリングされる
• 内部リンクが正常に動作する

執筆ルール

1. 章の選択

• outline.md の順序に従って進める
• 依存関係がある場合は先行章を優先

2. 参照記事

部	参照先
第1部：基幹業務システムの全体像	概要.md
第2部：販売管理システム	販売管理_2/
第3部：財務会計システム	財務会計_2/
第4部：生産管理システム	生産管理/
第5部：エンタープライズインテグレーション	各部の連携仕様

3. 執筆フォーマット

# 第N章：章タイトル

## N.1 セクションタイトル

本文...

### ダイアグラム

\<img src="data:image/svg+xml;base64,PD9wbGFudHVtbCAxLjIwMjYuMD8+PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiBjb250ZW50U3R5bGVUeXBlPSJ0ZXh0L2NzcyIgaGVpZ2h0PSIxMzZweCIgcHJlc2VydmVBc3BlY3RSYXRpbz0ibm9uZSIgc3R5bGU9IndpZHRoOjQwOXB4O2hlaWdodDoxMzZweDtiYWNrZ3JvdW5kOiMwMDAwMDA7IiB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA0MDkgMTM2IiB3aWR0aD0iNDA5cHgiIHpvb21BbmRQYW49Im1hZ25pZnkiPjxkZWZzLz48Zz48cmVjdCBmaWxsPSIjMTAwODIxIiBoZWlnaHQ9IjEiIHN0eWxlPSJzdHJva2U6IzEwMDgyMTtzdHJva2Utd2lkdGg6MTsiIHdpZHRoPSIxIiB4PSIwIiB5PSIwIi8+PHRleHQgZmlsbD0iIzMzRkYwMiIgZm9udC1mYW1pbHk9InNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iMTIiIGZvbnQtc3R5bGU9Iml0YWxpYyIgZm9udC13ZWlnaHQ9ImJvbGQiIGxlbmd0aEFkanVzdD0ic3BhY2luZyIgdGV4dExlbmd0aD0iMTI4LjAwOTgiIHg9IjUiIHk9IjE3Ij5QbGFudFVNTCAxLjIwMjYuMDwvdGV4dD48cmVjdCBmaWxsPSIjMzNGRjAyIiBoZWlnaHQ9IjIxLjI5NjkiIHN0eWxlPSJzdHJva2U6IzMzRkYwMjtzdHJva2Utd2lkdGg6MTsiIHdpZHRoPSIxNzMuMjgxMyIgeD0iNSIgeT0iMjYuOTY4OCIvPjx0ZXh0IGZpbGw9IiMwMDAwMDAiIGZvbnQtZmFtaWx5PSJzYW5zLXNlcmlmIiBmb250LXNpemU9IjE0IiBmb250LXdlaWdodD0iYm9sZCIgbGVuZ3RoQWRqdXN0PSJzcGFjaW5nIiB0ZXh0TGVuZ3RoPSIxNzEuMjgxMyIgeD0iNiIgeT0iNDEuOTY4OCI+W0Zyb20gc3RyaW5nIChsaW5lIDMpIF08L3RleHQ+PHRleHQgZmlsbD0iIzMzRkYwMiIgZm9udC1mYW1pbHk9InNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iMTQiIGZvbnQtd2VpZ2h0PSJib2xkIiBsZW5ndGhBZGp1c3Q9InNwYWNpbmciIHRleHRMZW5ndGg9IjQuODc0IiB4PSI1IiB5PSI2Mi4yNjU2Ij4mIzE2MDs8L3RleHQ+PHRleHQgZmlsbD0iIzMzRkYwMiIgZm9udC1mYW1pbHk9InNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iMTQiIGZvbnQtd2VpZ2h0PSJib2xkIiBsZW5ndGhBZGp1c3Q9InNwYWNpbmciIHRleHRMZW5ndGg9IjgxLjQyMjkiIHg9IjUiIHk9Ijc4LjU2MjUiPkBzdGFydHVtbDwvdGV4dD48dGV4dCBmaWxsPSIjMzNGRjAyIiBmb250LWZhbWlseT0ic2Fucy1zZXJpZiIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGxlbmd0aEFkanVzdD0ic3BhY2luZyIgdGV4dExlbmd0aD0iMTUuOTU1MSIgeD0iNSIgeT0iOTQuODU5NCI+Li4uPC90ZXh0Pjx0ZXh0IGZpbGw9IiMzM0ZGMDIiIGZvbnQtZmFtaWx5PSJzYW5zLXNlcmlmIiBmb250LXNpemU9IjE0IiBmb250LXdlaWdodD0iYm9sZCIgbGVuZ3RoQWRqdXN0PSJzcGFjaW5nIiB0ZXh0LWRlY29yYXRpb249IndhdnkgdW5kZXJsaW5lIiB0ZXh0TGVuZ3RoPSIyNi4xMTMzIiB4PSI1IiB5PSIxMTEuMTU2MyI+XGBgYDwvdGV4dD48dGV4dCBmaWxsPSIjRkYwMDAwIiBmb250LWZhbWlseT0ic2Fucy1zZXJpZiIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGxlbmd0aEFkanVzdD0ic3BhY2luZyIgdGV4dExlbmd0aD0iMzkyLjMzNSIgeD0iOS44NzQiIHk9IjEyNy40NTMxIj5TeW50YXggRXJyb3I/IChBc3N1bWVkIGRpYWdyYW0gdHlwZTogc2VxdWVuY2UpPC90ZXh0Pjw/cGxhbnR1bWwtc3JjIHF6Rkp1dWY5STRaV3ViOU1MYlBtM0w5dUVkaXA1cllhODJTbmh3R3FEdVNoRFF5YWl3SElHVWJuU3psWnZac0Zjd1N6UmJ4elQ0QWxhYThyYm52R1Rvc0lfZ1Zodmh6T3RDaDVQUEVJTWZBT2NMRGluc0xKTjlnUmNyWEtRSFNTdzBFTGpqNjdZSzRpQVl4Q3VOOEVTZEtDU0xLOFNOSm9TTE5HV3hsOUhYemM0MDAwPz48L2c+PC9zdmc+" class="uml" alt="uml diagram" title="" />
- タスク項目などは一行開けて記述する
- NG
  ```markdown
    **受入条件**:
    - [ ] ログアウトボタンをクリックするとログアウトできる
    - [ ] ログアウト後、ログイン画面に遷移する
    - [ ] JWT トークンが無効化される
  ```
    - OK
  ```markdown
    **受入条件**:

    - [ ] ログアウトボタンをクリックするとログアウトできる
    - [ ] ログアウト後、ログイン画面に遷移する
    - [ ] JWT トークンが無効化される
  ```

### 4. 実装同期チェックリスト

- [ ] テーブル定義が執筆内容と一致
- [ ] カラム名・型が一致
- [ ] リレーションが一致
- [ ] サンプルデータで動作確認済み

## ファイル構成

docs/article/ ├── index.md # 記事トップページ（目次） ├── outline.md # 全体構成 ├── workflow.md # 本ファイル（執筆ワークフロー） ├── part1/ # 第1部 │ ├── chapter01.md │ ├── chapter02.md │ └── chapter03.md ├── part2/ # 第2部 │ ├── chapter04.md │ └── ... ├── part3/ # 第3部 ├── part4/ # 第4部 ├── part5/ # 第5部 └── appendix/ # 付録 ├── er-diagrams.md ├── table-definitions.md └── glossary.md ```

進捗管理

章	ステータス	執筆日	実装日	同期確認日
第1章	未着手	-	-	-
第2章	未着手	-	-	-
...	...	...	...	...