ソフトウェアのデザインドキュメントにどのくらいの時間を費やしますか？

Question

明らかに、あなたが取り組んでいるプロジェクトの規模は、デザインドキュメント/仕様の作成に費やす時間の大きな要因になります。しかし、あなたはすべてを経験し、すべての小さな詳細を選びますか？それとも、よりアジャイルなアプローチを取り、ソフトウェアをかなり早い段階で書き始め、問題を解決しますか？

私はいつもあなたがデザインに行くことができることが今のところしかないことを発見しました。必然的に見逃されるものがいくつかあり、その時点で、あなたが状況にどれだけうまく適応できるかは、仕様自体よりも多くを意味します。

私はこれについて正しい視点をとっていますか？それは実際に意見ですか、それとも完璧なデザイン仕様は常に行くのに最適なルートですか？

Answer 1

それはあなたのターゲットオーディエンスに少し依存しますが、私の経験（非常に大規模な作業よりも小規模/中規模の開発の多く）は、詳細なデザイン文書が骨の折れることで退屈であり、めったに読んでいない、そしてそれによって時代遅れになる傾向があることですプロジェクトが配信される時間。

これは彼らが価値がないという意味ではありません - あなたが誰かのために何かを提供している場合、誰もが取引に不満を抱いて言う場合に誰もがそれを指摘できるほど十分に詳細に配信されるものについて、権威ある合意された声明が必要である必要があります」これは私たちが約束したものです」と、配信されたものに対してそれを評価します。

しかし、製品を構築するために会社を設立していた場合、詳細な仕様についてそれほど心配することはありません。文書化したいと思います 何 私たちはやろうとしていましたが、私はあまりにも多くの深さになりたくありません どうやって - それは、文書を時代遅れにして、役に立たない、または実際に妨害するほど十分に不正確である可能性が最も高い部分です。言語が最もサポートされているドキュメント形式を使用して、コードの「方法」のものを文書化することをお勧めします。そのため、コードが変更されると、ドキュメントを同時に更新しやすくなります。時代遅れになるのを止めることはありませんが、やや減少します。

理想的には、コードが完了したときにマニュアルを兼ねることができるデザインドキュメントが必要ですが、それをうまく管理した人は誰も知りません。

Answer 2

それは間違いなくプロジェクトのサイズと構造に依存します。

クライアントプロジェクトの場合、詳細な仕様は必須です。設計仕様中にクライアントを頻繁に巻き込むのが好きです。これにより、追加の考慮事項を洗い流すのに役立ち、クライアントに何が期待できるかをよりよく理解できます。通常、発見と仕様が完了した後、通常（時間と価格設定に対する）態度には前向きな変化があります。これにより、マイルストーンを設定し、ヒットすることもできます。これは、クライアントと開発チームにとって有利です。

内部プロジェクトと楽しいサイドプロジェクトの場合、通常、フローチャートと機能リストを作成し、一緒にハッキングを開始します。これらの例では、機能スペックシートよりも重要だと思うのは、実際のUIです。サイトを紙にワイヤーフレームし、簡単なUIビルド（HTML/CSS）を実行します。これは、ユーザーエクスペリエンスを通して考えるのに役立ちます。これは、自分のプロジェクトで特定の機能以上の機能を大切にしています。私はいつでも戻って、後で機能することができます。

Answer 3

デザインドキュメントの意味に依存します。

私は、私が書いたソフトウェアのデザインをメモ帳で書き留め、物事をスケッチし、アルゴリズム、人間関係、ストーリーなどを考え出します。

私はこれをすべて前もってしません。

私は仕事をしているメインの署名と封印されたドキュメントを持っていません。私は過去に持っていましたが、何かが何かを締めくくるのをいつも待っていたので、仕事を成し遂げませんでした。それは、前もってすべてのデザインの概念よりも、私が一緒にいた会社の官僚制度にとってより問題でしたが、私は今、私が持っているより流動的/アジャイルなアプローチを好みます。