技術仕様の構造

サイトの開発に関する技術仕様を作成する際に私が尋ねた質問、それを顧客にとってできるだけシンプルで理解しやすくする方法、しかし同時に、将来の製品(サイト)の機能を可能な限り制限し、文書化します。 私は多くの異なる例、TKを提出する方法を見て、それを調べなければなりませんでした-今私は私のアイデアと推測を共有しています。





TKは、他の重要なドキュメントと同様に明確な構造を持たなければならないことは周知の事実であり、タスクを作成するときは厳守する必要があります。そうしないと、顧客だけでなく実行者(開発者)も理解できないという混乱が発生します長い間、すべての目はそれによって砲撃されます。 私は自分で次の構造を選択しました。

  1. サイトのセクション。 ここでは、サイトで利用できるサイトのすべてのセクションとサブセクションをリストする必要があります。 各セクション(サブセクション)の内容を詳細に説明する必要はありません。これについては後ほど説明しますが、それらをリストするだけです。
  2. サンプルページ。 ここでは、サイトで利用できるすべてのタイプのページをリストする必要があります。 例:タイトルページ、検索結果の表示、印刷の種類など。
  3. サンプルページのレイアウトを設計します。 怠けてこのアイテムを見逃さないでください。 ここでは、視覚的に(またはテキスト形式で)サイトのどこの要素がページに表示されるかを単に示す必要があります。 このアイテムは、デザイナーと一緒に準備して、すべての概念的な問題を解決できます。 既成のレイアウトを適用する必要はまったくありません。 これは、後で顧客が1つまたは別の要素を移動または移動したいという欲求を持たないようにするために必要です。
  4. プロジェクトのソフトウェア部分。 サーバーテクノロジー-PHPなど、このサイトで使用するすべてのテクノロジーを怠laに描いたり、すべてのクライアントテクノロジーをリストしたりしないでください。 このアイテムは、念のためPHPなどをサポートしていないホスティング顧客の選択から身を守るために必要です。 多すぎないと思います...
  5. サイトのコンテンツと機能。 ここで、セクションの名前(サブセクション)、その説明、およびプロパティ(閉じたセクション、動的、追加ウィンドウに表示、メインメニューの項目)を含むプレートを挿入できます。
  6. 追加情報。 ここでは、前の段落で何らかの理由で解決されていないものを示す必要があります。 多くはないはずです。 たとえば、次のセクションのティーザーとこれらのセクションのリストを作成し、ローン計算機を開発します(説明はこちら)。 このセクションのいくつかのポイントは、たとえばローン計算などのサブセクションに分割できます。機能、外観、技術コンポーネントなどです。


この構造は、将来のサイトの技術および設計コンポーネントを完全に反映していると思います。 不正確な点がある場合、またはこのTKがフィードバックやコメントの待機に失敗する場合。



PS将来的には、TKの開発に関するより多くの資料を作成する予定です。それは、顧客とのプレゼンテーション、編成、および説明の方法です。




All Articles