Open23

開発ドキュメント雑まとめ

Masashi KondoMasashi Kondo

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

Masashi KondoMasashi Kondo
  • 仕様書
    • 完成イメージを明確にした資料
  • 設計書
    • 完成するまでの制作工程を明確にした資料
Masashi KondoMasashi Kondo

画面仕様書

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

Masashi KondoMasashi Kondo

デザイナーの方との雑談

本来、意匠設計と情報設計(ワイヤー)は分けるべき
デザインシステムがあるならそれをStorybookなどで管理し、それを意匠設計とする
設計書とコードの二重管理になってしまう
情報設計はXDなどを使ってドキュメント化する

Masashi KondoMasashi Kondo

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

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

Masashi KondoMasashi Kondo

成熟度モデル

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 段階プロセス