ドキュメントに関する覚書
MEMO-1. ドキュメンテーションの原則
- (1) ドキュメントを書く目的は設計を文章にエンコーディングすること
- (2) したがって、ドキュメントは合理的な推論によって設計をデコードできるものでなくてはならない
参考資料
ドキュメンテーション
- ドキュメントエンジニアリングとAPIドキュメンテーション - LINE ENGINEERING
- ソフトウェアドキュメント作法 - maru source
- テクニカルライティングの基本 - Speaker Deck
仕様書
- ゲームの仕様書を書こうまとめ
- ゲームの仕様書を書こう１ 仕様書作成の分業とリストの作成
- ゲームの仕様書を書こう２ 仕様書に記載する機能内容
- ゲームの仕様書を書こう３ 仕様書に記載するデータと画面
- ゲームの仕様書を書こう４ 仕様書作成で楽をするconfluenceの活用
- 仕様書作成のポイント_180814
ユーザーマニュアル
ADR
- 実践ADR - kawasima
- architecture_decision_record/microsoft-azure-devops.ja.md at japanese · kawasima/architecture_decision_record
- 継続的ドキュメンテーション: Github DiscussionsとADRのすすめ - LIFULL Creators Blog