開発を円滑に行うために作られるドキュメント及びそれを作成する手法について蓄積したい

ADR

https://zenn.dev/souppower/articles/bfdf79069ae9a7?s=09
https://zenn.dev/goldeneggg/scraps/5974c5f0a36661
https://adr.github.io/
https://fintan.jp/page/1636
https://blog.studysapuri.jp/entry/architecture_decision_records#:~:text=軽量なアーキテクチャデシジョンレコード,ことが容易になる。&text=重要なアーキテクチャ上の,背景および影響を書き留める。
https://qiita.com/fuubit/items/dbb22435202acbe48849

https://twitter.com/msy78/status/1496361562151723009
https://twitter.com/dmikurube/status/1496501044268118020
https://www.lifull.blog/entry/2021/09/08/100000

https://tech.route06.co.jp/entry/2023/08/08/115253

Design Doc

https://www.flywheel.jp/topics/design-doc-of-design-doc/
https://shimo5.me/post/2019-12-13/
https://atmarkit.itmedia.co.jp/ait/articles/1606/21/news016.html
https://speakerdeck.com/toricls/you-wont-be-in-the-team-forever
https://docs.flutter.dev/resources/design-docs

https://qiita.com/yoshii0110/items/32f93e0c8d24cb3207f7
https://r-kaga.com/blog/collection-of-resources-for-writing-a-good-design-docs
https://note.com/kosukemori/n/n968cd16c53eb
https://speakerdeck.com/munetoshi/how-to-write-a-design-doc-ja-ver-dot

PRD

https://note.com/miz_kushida/n/n7e35a2a2b370

https://hiroki-shimada.medium.com/スタートアップのための製品要求仕様書-mrd-prd-の書き方-d5088d795ba5

https://www.slideshare.net/takoratta/prd-192302662
アジャイル開発との相性悪い問題

包括的なドキュメントよりも動くソフトウェアを、

アジャイルソフトウェア開発宣言

対策

• OnePager
  • プレスリリースを先に作成する
    • 「すべてプレスリリースから考えよ」アマゾンジャパンのPMに学ぶ仕事の流儀とキャリア展望【及川卓也のプロダクトマネジャー探訪】
• リーンキャンパス
• インセプションデッキ

https://www.ipa.go.jp/sec/tool/ep/ep2.html
https://note.com/jun0322/n/nac4f624d3ba6

画面仕様書

https://liginc.co.jp/374199

意匠に関わることやアニメーションについては定義すべきじゃないと考えています。
というのも、文章での表現が非常に難しいからです。
ここらへんも指定は別資料として、デザインガイドラインやアニメーションのサンプルや参考をまとめたものを作成するのがいいと思います。

https://enlyt.co.jp/blog/interview-spec/

https://link.medium.com/qT0SLLwvSjb

https://blog.adobe.com/en/publish/2017/11/21/design-specifications-speeding-design-development-workflow-improving-productivity.html

https://nhiroki.jp/2021/09/24/coding-before-overthinking

なお詳細な設計やデザインドキュメントの重要性を低く見ているわけではないです。むしろこれらは可能な限り早い段階で明文化されるべきと考えています。一方でそれらは実装開始をブロックするものではなく、むしろプロトタイプを通して育てていくものだと考えています。

SRE関連

https://cloud.google.com/blog/ja/products/gcp/how-to-start-and-assess-your-sre-journey

成熟度モデル

https://www.mediawiki.org/wiki/Documentation/Maturity_model_for_MediaWiki_technical_documentation

https://www.researchgate.net/publication/319284073_Information_Process_Maturity_Model

https://faculty.eng.fau.edu/shihong/files/2011/08/SIGDOC2003_DMM_Huang_Tilley.pdf

施策について

https://onk.hatenablog.jp/entry/2021/09/30/194656

• トヨタ生産方式の 5S
  • 躾 が含まれている
• 問題解決の 8 ステップ
  • 目標設定や計画、定着させることが含まれている
• ADR (Architecture Decision Records) や Design Doc
  • 意志決定をテンプレ化し、記録を取っていく
• インセプションデッキ
  • 前提を丁寧に揃える役に立つ
• DACI フレームワーク
  • 意志決定に関わる人の役割を明示することで推進力を出す
• コッターの 8 段階プロセス
  • 変革に当たっての 8 段階プロセス
• ADKAR モデル
  • 同じく変革のための 5 段階プロセス

https://twitter.com/ynakazat/status/1443255083387424770?s=19

https://twitter.com/fushiroyama/status/1443314843105120259?s=09

https://twitter.com/shin_sasaki19/status/1475623500228739076?s=19

Inception Deck

https://blog.nextscape.net/research/agile/inceptiondeck

https://www.mof-mof.co.jp/blog/column/management-ajile-with-inception-deck

要件定義

https://qiita.com/Haruyuki_Hirose/items/2ce5a2877bc5c66aa2b3

仕様書管理方法

https://qiita.com/S346/items/83920b555175d751eaf9
https://blog.spacemarket.com/code/document/
https://webdesign-trends.net/entry/9618

https://note.com/tanabemg/n/na2db89a5cbda

https://agnozingdays.hatenablog.com/entry/2022/01/25/232456?s=09

https://product-develop.com/2c981f18e9924410bb266a5fd87343c2

https://tech.toreta.in/entry/2023/12/18/142509
https://hisaichi5518.hatenablog.jp/entry/2022/02/10/080000

https://twitter.com/iwashi86/status/1533566079561236482

https://gfngfn.github.io/ja/posts/2022-06-18-be-a-documentation-geek/

行動ログドキュメント

https://speakerdeck.com/starhoshi/da-tong-rogawoli-yong-sitasabisukai-fa

mini spec

http://techblog.housmart.co.jp/2018/03/20/minispec/

https://note.com/otapo/n/n140b39e64337

テクニカルライティング

https://speakerdeck.com/naohiro_nakata/technicalwriting2023

https://kumagi.hatenablog.com/entry/write-beautiful-code

https://speakerdeck.com/akitok_/sustainable-documentation-strategies-documentation-as-a-product