操作
資料整理 #21
未完了設計 #1: 開発運用プロジェクトのスケジュール
ドキュメント(README.md,図の整理)
開始日:
2023-08-16
期日:
2023-09-05 (約14ヶ月 遅れ)
進捗率:
0%
予定工数:
(合計: 0:00時間)
説明
概要¶
- 第三者にチケットやイシューの情報を共有できるように、ドキュメントを記載する必要がある。
チケット¶
資料種類 | 説明 | チケット |
---|---|---|
README.md | プロジェクト全体に関してまとめたドキュメント | 資料整理 #22: README.md(プロジェクト全体)の作成 |
README.md | Terraformに関してまとめたドキュメント | 開発実装 #17: Terraformの初期設定を完了される で対応済。 |
README.md | Railsに関してまとめたドキュメント | 資料整理 #33: Rails(ログイン処理)に関するREAMD.mdを作成 |
UML図 | ログイン処理にまとめたUML図 | |
シーケンス図 | ログイン処理にまとめたシーケンス図(アプリ) | 資料整理 #32: ログイン処理にまとめたClassやActionに関するシーケンス図 |
シーケンス図 | ログイン処理にまとめたシーケンス図(インフラ) | 資料整理 #23: ログイン処理に関するシステム間の通信をまとめたシーケンス図作成 |
サーバー構成図 | インフラの構成についてまとめた図 | |
ドキュメントの運用方法¶
シーケンス図¶
- 特に複雑な処理を伴う機能ごとにシーケンス図を作成する。
doc
ディレクトリにシーケンス図ファイルを配置する。
操作