より良いプロジェクト仕様を書く

仕様は、展開のテストと管理とともに、タイムシンクです。彼らはプロジェクトの人生の日々を飲み込み、彼らが約束したことをしません。

しかし、それらは必要です。短いブリーフが必要な場合でも、マーケティング責任者との承認が必要な場合でも、あなたとチームが実際に日常的に使用できるドキュメントを用意しておくと、プロジェクトの勢いが維持されます。

私たちはこれに頭を悩ませました。持っていたすべての仕様を確認しました。すべてのクラッドを削除しました。仕様は、作成しているアプリと同じくらい協調的である可能性があることがわかりました。

スペックも必要ですか?

仕様は、現実の世界がどのようなものであるかについての不十分な説明です。それらは、機能するものを構築するためのショートカットです。 37シグナル 何年もの間、微調整できる機能するコードがある方が常に良いと言ってきました。

高価なモックアップよりも説明が不十分な方が安全な場合もありますが、誰もが焼きたい100ページのドキュメントを作成することに戻らないようにしてください。

チーム、企業、タイムゾーン、国を超えて共同作業を行う代理店業務では、合意された計画を立てることが不可能な場合があります。仕様から最後に必要なのは、開発を開始する前にチームの労力の半分を消費するものです。

あ、はい。できる限りスペックを避けますが、スペックを書く必要がある場合、どのようにしてそれを無駄のない状態に保ちますか?

スペックのポイントは何ですか?

仕様のポイントとは何かから始めましょう。ありますが たくさんの そして 異なる 仕様をどのように書くべきか、あるいはその理由についてのアイデアは、代理店やチームで働く人は誰でも質問する必要があります。



  • これは何で、何をするつもりだったのですか?

そして、彼らは尋ねます:

  • 本来の目的を達成するために、どのようにすればよいですか?

もっとユートピアになりましょう。

仕様は、書きにくく、読みにくいものであってはなりません。もしそうなら、それらを書いたり読んだりする人々は、プロジェクトではなくフォーマットに頭を入れるためにエネルギーを浪費するでしょう。

スペックは必要以上に大きくしてはいけません。バージョン履歴とプリアンブルを破棄します。

仕様を曖昧にしたり、非コミットにしたりすることはできません。一般的なアイデアはあるが、それをどのように実装するかについての正確な計画がない場合は、仕様ではなく質問があります。正直に言ってください。

読み書きが簡単で、より正直な、より軽いドキュメントが必要です。そして便利です。

最近のスペックは…

それが私たちのユートピア的な夢ですが、今はどうですか?

私たちが仕様を捨てて、クライアントにそれに続くように説得するように私を駆り立てた欲求不満は、主に読者が何かを成し遂げるのを助けるよりも作家を気分良くさせるために書かれたように見える矛盾する半読文書から来ました。

コミュニケーションがすべてであり、人々が常に読者のために書いている業界では、開発者とデザイナーのチームのために書くことができる人が非常に少ないのは驚くべきことです。

ほとんどのプロジェクトは、自己利益のベン図から始まります。チームの各部分は、他のドキュメントを参照するか、責任を渡すかのいずれかで、ドキュメントを作成します。

ビジネスレベルの仕様は、数文からビジネスのプロジェクトの目的まで多岐にわたります。マーケティングブリーフは、コンバージョン、訪問数の増加、またはブランドの変更を目的として始まります。次に、機能仕様、IA、設計、および技術仕様があります。

これらのそれぞれがいくつかの質問に答え、他の質問を提起しますが、それらはお互いを参照しているため、どれも権威がありません。たとえば、「これは設計で具体化されます」または「技術仕様はここでより詳細を追加します」および「IAドキュメントの構造TBC」。

そのメール、添付ファイル、Basecampスレッド、Googleドキュメント、Githubの要点などに加えて、元の意図を見つけるのが非現実的に困難になっています。だから人々はそうしません。彼らは自分たちが持っている文書から最善の推測や作業を行い、その後事態はうまくいきません。

最後に、各仕様とブリーフの問題は、それらが更新されていないことです。開発者が何か別の方法で行う必要があることに気付いた場合、または設計者が設計を微調整した場合、ドキュメントを更新する必要がないため、せいぜい役に立たず、最悪の場合、プロジェクトを開始する人に損害を与えます。

これは、20の付録を含む数百ページの厚さの、ヘビースペックフォーマットの前文のように聞こえます。そうではありません。私たちはまだフォーマットを無駄のない実用的なものに保つ必要があります。

それはどうあるべきですか?

コピー書き込みを必要とするアプリを構築するのと同じように、新しいAPIからのJSONフィード、フロントエンドコーディング、ネイティブプログラミングの仕様は、1人だけのドメインであってはなりません。製品だけでなく、スペックにも協力します。

次に、プロジェクト全体で全員が編集する1つの信頼できるドキュメントを保持します。これはプロジェクト管理の異端であり、私は良い仲間ではないことを知っています。どちらにしても ...

このドキュメントを作成してDropboxに載せましょう。 Googleドキュメントやその他の共同作業場所は問題ありませんが、プロジェクトマネージャーにいつでも唯一のコピーを持たせないでください。

ここで、構造化されているが、理解するのにほぼゼロ秒を必要とするフォーマットが必要です。何年にもわたる仕様、概要、デザイン、ワイヤーフレームを分析し、それらをUX、コンテンツ管理、実装、質問に抽出しました。そして写真。

写真から始めましょう。すべてのページの中央に写真があります。キックオフミーティングからの落書き(おそらくプロジェクトのより正確な写真です)、ワイヤーフレームまたはデザインのモックアップ。すべてのページをストーリーとして扱い、ユーザーがそのストーリーを生きているときに何が表示されるかを示します。

UXは、あらゆるユーザーに対して何をするかをカバーします。ページに表示されるコンテンツ、ビデオのスライド方法、ユーザーが見つけることができる情報。これは、IAワイヤーフレームおよび機能仕様で一般的であるため、IAまたはプロジェクトマネージャーによって作成されることがよくあります。

コンテンツ管理は、ビジネスユーザーがページのコンテンツを変更する方法を説明します。実装は、技術仕様、コード参照、およびAPIノートが行くところです。コーダーの領域ですが、それを共有することで、プロジェクト全体でアイデアやプロトタイプを進歩させ続けることができます。

最後に、質問です。未定または曖昧なものはすべてここにあります。あなたは厳格でなければなりません。多くのブリーフと機能仕様の最初の罪は、それらが販売文書のように読まれるということです。

「コンテンツ編集者はホームページのどの部分でも編集できるようになります。」

いいえ、しません。彼らはおそらくいくつかのニュース記事を宣伝し、バナーを変更することができるでしょう、それでそれを言ってください。

'予約フォームは、既存の予約システムを使用して実装されます。 TBCを設計します。」

質問のように聞こえます:「ディーンに予約システムの設計オプションを調べて設計を行わせる」。実用的である。

質問について正直であるということは、2つのことを行います。仕様の不完全さについてより正直であり(つまり、プロジェクトのほとんどでまだ質問があります)、チームの他の人が見ることができるので、質問に答える負担を分担できます。何を決定する必要があります。

真実が変わっても、それを真実に保つ

更新されていないスペックは死ぬので、スペックの写真を現実を最もよく反映するもので更新して、あなたの生き生きとした状態を保ちましょう。

スケッチから始めた場合は、何か別のもので更新してください 情報を追加します 。簡単なものから機能仕様、ワイヤーフレーム、そしてデザインまで、すべてのページを作り直す無意味で費用のかかる作業を回避します。

あなたの意図のより良い表現があるときはいつでも、すぐに古い表現を置き換えてください。スケッチをデザインに置き換え、スケッチを二度と使用しないでください。「どのバージョンが正しいか」という質問を完全に回避できます。

これを既存のページに適用する方法は次のとおりです。

ドン

デザインやワイヤーフレームがないので、プロジェクトを控えないでください。キックオフからのスケッチは、おそらく数週間で最高の表現になるので、スケッチしてください

...しかしドン

...しかし、それについては貴重ではありません。最終的な調整が必要な場合は、思ったとおりにではなく、全員がページについて話していることを確認してください。

それですか?

私たちがやったことは、チームをより早く一緒に働かせることだけです。仕様戦争のベン図の代わりに、私たちは最初からすべてが1つのことを参照して更新するように協力します。

UXの専門家、IA、デザイナーが作成する仕様は、プロジェクト全体で真実の単一のアイデアを維持するために開発ノートとマージされます。そして、完成したページやアプリが私たちが望むものをよりよく反映している場合は、代わりにそれらを使用します。

Visio、Photoshop、またはコピーが最適だと独断的に考えないでください。

ここにあることの多くは新興企業やアジャイルチームによって行われていますが、代理店はプロジェクトを指定するための最良の方法をしっかりと持っている必要があります。

極端な場合、開発時間を数週間から数日に短縮し、仕様の日数を削減したため、プロジェクトマネージャーはプロジェクトを嫌いになりました。

これは特効薬にはなりませんが、ブログがどのように機能するかについての別の50ページの説明を読むことを避けたくない人はいますか?

Bigstockの「仕様」画像。