技術仕様サンプルを正しく書く方法。 GOSTに基づく技術仕様

技術仕様の開発は、作成される自動化システムの基礎です。この文書は EDMS 実装のどの段階で作成され、その中に何を含めるべきですか? この記事では、技術仕様の開発に関連するこれらの基本的な質問とその他の多くの重要な質問に対する回答をお読みください。

委託条件（以下、TK）は、組織のプロセスの分析と、これらのプロセスを自動化するための概念的な提案の結果です。技術仕様の作成を開始する前に、プロセスに関する情報調査を実施し、調査報告書の形で作成し、自動化のアイデアそのものを含み、自動化の目標を明らかにする自動化コンセプトを開発する必要があります。、システムのアーキテクチャや構成についての基本的な提案も行います。同時に、情報プロセスとその概念に関する報告書は、「現状」と「あるべき姿」という 2 つのパラダイムで作成する必要があります。これらのレポートへの非常に便利な追加機能は、選択した方法論におけるプロセスのグラフィック表示 (いわゆるプロセスモデリング) です。今日のロシアの実践で最も一般的な方法論は記法です アリス* 同じ名前のツールと UML**。 EDMS 開発は常にプロジェクト活動、始まりと終わりがあります。開発は、システムを商用運用に移行し、EDMS をサポートするプロセスを開始することで終了します。

EDMS 開発のプロジェクトマネージャーは、システムを作成するときに、カスケードモデルと反復モデルのどちらの方法論を使用するかの選択に常に直面します。

1. カスケードモデル。

カスケード開発モデルまたはクラシック開発モデル ウォーターフォールモデル- ウォーターフォールモデル) は、開発プロセスが要件分析、設計、実装、テスト、統合、サポートの各フェーズを順番に通過する流れのように見えるソフトウェア開発プロセスのモデルです。

カスケードモデルでは、EDMS 作成の段階が次々に進み、ある段階の結果が次の段階の結果に発展します。このモデルでは、前の段階に戻ることは非常に問題があり、プロジェクトの多くの仮定を処理して再考する必要があります。ロシアの GOST 標準はこの方法論に従って構築されています。

2. 反復モデル。

反復的なアプローチ反復- 繰り返し) - 得られた結果の継続的な分析と作業の前の段階の調整と並行して作業を実行します。同時に、開発の各フェーズでは、計画→実装→検証→評価というサイクルが繰り返されます。

反復開発モデルは、各段階での段階的な開発です。完全なプロセス EDMS を作成しますが、機能の範囲は限られています。開発プロセスは、機能を継続的に強化するこのような繰り返しで構成されます。

これらのアプローチのどれが正しいかは、特定のプロジェクト (プロジェクトのタスクの範囲) と顧客の希望によって異なります。

ただし、選択した開発モデルに関係なく、それぞれに、作成された EDMS の要件を形成する段階があります。この段階と技術仕様自体の作成規則は、ロシアの法律、つまり第 34 シリーズの GOST に記載されています。基本文書 - GOST 34.602-89。情報技術。自動化システムの標準のセット。自動化システムの作成に関する技術仕様および RD 50-34.698-90。ガイドライン。情報技術。自動化システムのための一連の標準とガイドライン。自動化システム。書類の内容に関する要件。

反復的なアプローチでは、最初の要件の形成時に技術仕様が作成され、その後の要件の明確化によって、 非公開技術仕様 (ChTZ).

技術仕様の構成

GOST 34.602-89 によると、技術仕様の主要なセクションは次のとおりです。

1. 一般情報.

2. システムの作成（開発）の目的と目標。

3. 自動化オブジェクトの特性。

4. システム要件。

5. システムを構築する作業の構成と内容。

6. システムの制御と受け入れの手順。

7. システムを稼働させるための自動化オブジェクトを準備するための作業の構成と内容に関する要件。

8. 文書要件。

9. 開発の源。

これらすべてのセクションはサブセクションに分割でき、付録が含まれる場合があります。付録はドキュメントの最後に記載されており、技術仕様の付録として作成されます。 ChTZ にも同じ構成があり、大規模なプロジェクトで反復的なアプローチを使用して要件を明確にすることができます。 EDMS の技術仕様は、GOST 2.301-68* に従って、フレーム、主な碑文、および追加の欄を除いて A4 シートに作成する必要があります。

シート（ページ）番号は、EDMS 上の TK コードを示した後、タイトルページに続く最初のシートからシートの上部（本文の上、中央）に配置されます。

技術仕様のタイトルページには、次の詳細が記載されています。

「承認します」のスタンプを押します。

EDMS の正式名。

文書の名前 (この場合 - 「技術仕様」および「非公開技術仕様」)。

文書コード。

シート数;

文書が編集された場所。

承認ビザはタイトルページに配置することも、別の承認シートに配置することもできます。次の次タイトルページドキュメントの開発者、つまりドキュメントのテキストを編集した作成者、または技術仕様に記載されている技術ソリューションを作成した作成者に関する情報が記載されたシートがあります。承認シートと文書の開発者に関する情報は、GOST 34.602-89 (GOST の付録 3) の推奨に従って、技術仕様の 1 枚のシートに作成できます。最後のシートは技術仕様です。

EDMS の TK コードは設計文書の指定であり、GOST 2.201-80** に従って文書の顧客または開発者によって割り当てられます。コードは次の部分で構成されます。最初の 4 文字は開発組織のコード、次の 6 文字は分類特性コード、次の 3 桁はシリアル登録番号です。たとえば、TK 番号は次のようになります。

TSNTP。 425180.048。

技術仕様の一部のセクションの書き方の特殊性

章「 一般情報» には、顧客と請負業者候補、請負業者の決定方法、EDMS 作成の資金源となる予算、EDMS 作成のおおよその時期と作業段階に関する情報を含める必要があります。

たとえば、このセクションには、請負業者が政府との契約を締結することによって決定されることが示されている場合があります。

章「 システム作成（開発）の目的と目標» には、システム作成の主な目的と、システムの実装によって顧客が期待する結果の説明が含まれている必要があります。これらの結果は経済的に測定可能である必要があり、あるいは測定方法が指定されている必要があります。

たとえば、EDMS 導入の目標は、会社のすべての支店で契約の承認に必要な時間を 1 営業日に短縮することかもしれません。

章「 オートメーションオブジェクトの特徴» には、自動化が必要な組織内のプロセスの説明が含まれており、組織のプロセスの調査中に編集された情報調査レポートの結果です。

章「 システム要求"は技術仕様の主要なセクションです。このセクションは、将来のシステムの多くの技術的特徴を規制し、統合するものであるため、特に注意を払う必要があります。

このセクションでは、次の要件について説明します。

1. システム全体の要件（システムアーキテクチャの要件、職場の構成、システム担当者の要件、信頼性の要件、人間工学の要件、機密性の確保の要件（機密文書がシステム内で処理される場合）、保護の要件など）不正アクセスによる情報、システムのスケーリング要件など。

2. システムによって実行される機能 (タスク) の要件には、EDMS サブシステム (モジュール) の機能の説明が含まれている必要があります。

3. EDMS のサブシステム (モジュール) の相互作用の要件には、サブシステム (モジュール) の相互作用のメカニズムを記述しなければなりません。

4. 組織の関連システムとの相互接続の要件には、どのシステムが関連しており、どのように EDMS に接続できるかを記述する必要があります。

たとえば、人事記録システムは EDMS のユーザーのリストを提供する場合があります。 5. EDMS の動作モードの要件には、動作モード (たとえば、年中無休 24 時間) と、システムの再インストールまたは更新のための予防作業を実行する手順の説明が含まれている必要があります。

たとえば、システムのアップデートは、システムの機能を停止することなく実行する必要があります。

6. サポートの種類の要件には、システムの言語サポート、EDMS の入出力形式の要件、データベースの要件、組織サポートの要件、情報、ソフトウェア、およびテクニカルサポートシステム。

7. システム管理者の役割と責任の説明を含むシステム管理の要件。

「システム構築の作業の構成と内容」の項目は、EDMS 構築の作業段階の名称を示す表の形式で作成することをお勧めします。およその日付ステージの開始と終了、およびこれらのステージの終了の結果。

「システムの検査と受け入れの手順」セクションでは、システムを受け入れるためにどのような種類のテストを実行する必要があるかを決定する必要があります。これには、これらのテストの実行に必要な文書のリストも含まれます。

たとえば、システムを運用するために、顧客によって開発され承認されたプログラムとテスト方法論に従って部門テストを実行できます。

章「 システムの試運転に向けて自動化オブジェクトを準備するための作業の構成と内容の要件» EDMS ユーザーのトレーニング、マニュアルの開発、および教材、データの変換または EDMS への初期データの入力の要件、EDMS が機能するためのインフラストラクチャの作成の要件。

ドキュメント要件のセクションでは、次について説明します。一般的なルールシステムの作業文書を作成し、企業標準または GOST を参照する場合があります。

章「 開発ソース」は最終版であり、システムの開発と特定の技術的決定の採用の基礎となった文書をリストします。

この場合、技術仕様のテキストには、すべての開発ソースへのリンクが含まれている必要があります。特定の出典の指摘は、技術課題の本文で正当化され、確認されなければなりません。

この記事を読んで、より詳しく理解していただければ幸いです。規制の枠組み技術仕様、その構成および内容が完成し、この文書を使用する準備が整いました。

* ARIS (Architecture of Integrated Information Systems) は、Software AG が所有する方法論および複製可能なソフトウェア製品です
組織のビジネスプロセスをモデル化するために。
** UML (統一モデリング言語) は、ソフトウェア開発分野におけるオブジェクトモデリングのためのグラフィカル記述言語です。主にソフトウェアシステムを定義、視覚化、設計、文書化するために作成されました。

著者より：書き方 ウェブサイト開発に関する委託条件? このトピックは非常に広範囲にわたるため、1 つの記事の枠組み内で 100% 分析することは (可能であれば) 困難です。しかし一般規定、技術仕様を作成する際に何を考慮する必要があるか、何に注意を払う必要があるかについて、この記事で十分に詳しく概要を説明します。

それで、TK

委託条件はサイト開発者向けに用意されています。顧客と請負業者の間で契約を作成する際には、技術仕様を参照する必要があります。双方の技術仕様の要点および条件の不履行または不履行に対する責任を規定する必要があります。しかし、(私の意見では) 技術仕様が作成される最も重要なことは、 ウェブサイト開発プロセスのスピードアップ.

この例を分析してみましょう。

Web サイトのどこかにカレンダーが必要だと仮定しましょう。それは小さなことのように思えました。ただし、このカレンダーの機能を詳しく説明すればするほど、より早く結果が得られます。

ここで少し説明させてください。カレンダーとカレンダーは違います。当月の曜日別の数字をシンプルに表示するカレンダーがあります。月をめくることができるカレンダーがあります。月や年をめくることができるカレンダーがあります。

現在の日付が強調表示される、最新バージョンのカレンダー (月や年を切り替える機能付き) が必要だとします。仕様に「サイドバーにカレンダーが必要」と記載されています。顧客は、カレンダーの最初のバージョンを作成します (現在の月の曜日ごとの数字が表示されるだけです)。

私たちが持っているもの。請負業者は技術要件を満たしていましたが、あなたはまったく異なるカレンダーを求めていました。すべてが技術仕様に従っているように見え、誰も責めることはなく、矛盾はありませんが、最も重要なものが失われています 時間とお金.

これは単なる平凡なカレンダーの例です。

カレンダーの場合のように、処理に半日以上かかるような、より重大な処理をやり直す必要がある場合はどうすればよいでしょうか。そして、あなたはウェブサイトを持っておらず、顧客はプロジェクトを完了して新しいプロジェクトを開始できるにもかかわらず、あなたにちょっかいをかけています。

したがって、よりも さらに詳しく各サイトモジュールの機能を説明すると、より早く結果が得られます。双方がこれに関心を持つべきです。

技術仕様書は通常どのような点で構成されますか?

あなたが会社または企業のオーナーであると想像してみましょう。あなたの会社はあらゆる製品の生産と販売に携わっています。買い手がいるのです。販売者 (ショップやオンラインストア)、サービスセンター、製品の消費者と協力します。あるいは、そのような会社の Web サイトを作成していて、技術仕様を作成する必要があるとします。

あなたがどのような役割を果たしているかに関係なく、最初に行う必要があるのは、組織の構造、その内容、命名法、特徴、そして一般に製品と会社に関連するすべてのものを研究することです。現場で何が起こるかは、顧客が企業で起こっていることの本質をどれだけ深く理解しているかによって決まります。したがって、ここでのタスクは相互に行われます。顧客は企業についてできるだけ詳細に説明する必要があり、請負業者は何が起こっているのか本質を完全に理解する必要があります。

あなた自身が Web サイトを作成する会社の技術仕様を作成している場合でも、すべてを 1 枚の紙に書き出すことをお勧めします。

ポイントごとに見ていきましょう。

サイトの説明

ここには、会社とその事業内容についていくつかの文を書くことができます。紹介のようなことをします。

誰に向けて - サイトの対象読者:

潜在的な買い手
商品販売者（店舗、オンラインストア）
サービスセンター
パートナー（企業）
商品の消費者（すでに購入した人）

なぜウェブサイトが必要なのでしょうか?:

企業イメージを向上させるため
売上を上げるには
お客様の利便性のため

サイトの種類:

企業向け
ウェブサイト – 名刺
オンラインストア

言語バージョン:

英語
ロシア

サイトはいくつかの問題を解決する必要があります。したがって、私たちはサイトの目標と目的をさらに進めます。

サイトの目標と目的

技術仕様のこのセクションでは、対象ユーザー全体を調べ、サイトがそのユーザーのために解決すべきタスクの範囲について説明します。

潜在的な製品購入者.

目標: より多くの購入者を引き付け、最初の購入を説得し、選択を支援します。

問題を解決する必要がある:

製品、付加サービス、保証、サービス、選定方法などについて、質の高い包括的な情報を提供します。

ショールームのご案内
小売ネットワークに関する情報を提供する

製品の選択と購入に関する問題について、企業の専門家による潜在的な購入者向けのオンライン相談を企画し、質問する機会を提供します。

したがって、対象ユーザー全体を調査します。当社 Web サイトをフォローすると、製品販売者 (店舗、オンラインストア)、サービスセンター、パートナー (企業)、および製品消費者向けの目標と目的が説明されます。つまり、それぞれのサイトが具体的に何をすべきかということです。

次に、サイトモジュールをリストします。

サイトの機能

サイトの機能をリストするには、何が必要かを決定する必要があります。

このサイトにニュースが必要ですか?
それは必要ですか広告ブロック
登録は必要ですか?
サイトの非公開セクション (登録ユーザーのみ) は必要ですか?
フィードバックフォームは必要ですか?
メール送信スクリプトが必要ですか?
等。等々。

ここまで説明した後、最も重要で興味深いことに移ります。もちろん、上記で行われたすべての作業は非常に重要ですが、これからはさらに重要になります。

サイトの機能の説明

の上この瞬間私たちは、サイトが誰のためのものであるか、それが果たすべき目標と目的、そしてその追加機能を知っています。

収集したすべての情報をシステムに取り込み、Web サイトに美しく配置する必要がある時代が来ています。車輪の再発明をせずにタスクを簡単にするには、次のサイトを参照してください。似たような話題。彼らから何かを学び、その機能を見て試し、Web サイト上で不便に思われる点を改善してみてください。原則として、技術仕様を作成する最初の段階で、同様のトピックに関するサイトを参照できます (経験がない場合は、参照する必要さえあります)。

メニュー項目から始めることをお勧めします。サイトのメインページを表示し、各訪問者が自分の情報をすぐに見つけられるようにする必要があります。そして訪問者は私たちの対象者です。メニューには多くの項目が含まれるため、ドロップダウンリストの形式になります。

まずは会社について教えてください。会社、会社の歴史、連絡先、レビューに関するページが含まれる場合があります。

当然、メニュー項目「製品」があり、サブ項目として「製品カタログ」、「リリース」、「製品レビュー」が存在するはずです。

一般的に、それをどのように説明すればよいか明確になれば幸いです。私たちのウェブサイトで考えられるメニューの最終バージョンを紹介しましょう。

会社について

会社の歴史
連絡先
レビュー

ニュース

イベント
ストック
サイトの新しい

製品

製品カタログ
リリース
製品レビュー

サービス

サービス部門
保証サービス
保証後のサービス

消費者へ

購入と配送
使用
サービスについて

ショップとオンラインストア

製品写真
よくある質問

サービスセンター

どうなるかサービスセンター
よくある質問

パートナー向け

協力への招待
よくある質問

メニューを整理したようです。ここで、各ページに何が表示されるか、そしてそれがどのように機能するかを説明する必要があります。さらに、おおよそのサイトのレイアウトも提供します。鉛筆で紙に描き、スキャンして作業明細書に添付できます。ただひとつ言えるのは、デザイナーの想像力を制限しないで、自分でスケッチしてくださいということです一般的な見解.

この部分は、ページをどのように見せたいかによって変わります。おそらく、上部にそれほど多くのバナーは必要なく、上部に連絡先 (住所、電話、ファックス) を、おそらく「サイトマップ」、「ホーム」、「連絡先」アイコンの形式で示す必要があるかもしれません。おそらく、左側にニュースは必要ありませんが、左側に「プロモーションとリリース」を表示します。

ここで重要なことは、作業のロジックを説明することです。

動作ロジック

上の写真をもとに説明していきます。

サイトのトップは、サイトのどのページでも同じままです。ニュースフィードは以下でのみ表示されますホームページ。左側の二次ページには、現在いる項目のメニューサブ項目が表示されます（たとえば、「カスタマーサービス」ページにいる場合は、「保証サービス」、「保証後サービス」へのリンクが表示されます） ”）。したがって、これらのリンクをクリックすると、対応するページが表示されます。ここでは、左側のサブ項目の下に、オンラインコンサルタント (Skype、ICQ) に連絡するためのデータが表示されます。プロモーションとリリースのブロックは各ページに残ります。サイトのフッターはどのページでも同じように表示されます。

これは、作業の一般的なロジックを大まかに説明したものです。

ここで、各ブロックについて詳しく説明します。たとえば、「ニュースフィード」。

「ニュースフィード」10点満点中最新ニュース。各ニュースには、ニュースのタイトル、発行日、簡単なスタートニュース (4 ～ 5 行) と「全文を読む」リンク。「全文読む」リンクをクリックすると、ニュースページが表示されます。メインコンテンツの代わりに、あなたが見つけたニュースが表示されます。ニュースのタイトルと発行日も含まれます。左側にはニュースフィードも表示されます。過去数か月および数年間のニュースがアーカイブされます。つまり、当月のニュースの下に「（何月または何年）のアーカイブ」が表示されます。「（何月・何年）のアーカイブ」リンクをクリックすると、該当月・年のニュース一覧がドロップダウン表示されます。

各ブロックの動作を説明します。カレンダーの出来事を忘れないでください。そして最も重要なのは、製品カタログの仕事について説明する必要があることです。 ここであなたに任務を与えます: ディレクトリがどのように機能するかをよく考えて説明してください。オプションを電子メールで送信してください。最優秀作品を掲載させていただきます。

他に何があればいいでしょうか？互換性を示すと良いでしょう。

互換性

この段落では、どれかを示します。オペレーティングシステムどのブラウザでサイトが同等に美しく見えるか。どのバージョンで、どの言語で作成する必要がありますか。使用されているCMS。自分が何を言っているのかを実際に理解している場合は、これを指摘する価値があります。

これらの質問がわからない場合は、サイトが正しく表示されるブラウザを指定してください。残りは演奏者の良心に頼ってください。

結論

この記事では、これが技術仕様の編集方法であり、それ以外の方法ではないことを示そうとしたわけではありません。これを実行すれば問題はありません。高品質の技術仕様を作成するには、むしろ経験が必要です。最初の数年間で誰もが適切な技術仕様を作成できるわけではありません。

この記事では、委託条件が構築される原則と、注目に値する主な点を示したいと思いました。私がどこまで成功したかは、あなたのコメントから知りたいと思っています。

そして、タスクを忘れないでください！

著者より:書き方 Web サイト開発の委託条件 (TOR)? このトピックは非常に広範囲にわたるため、1 つのメモの枠組み内で 100% 分析することは (可能であれば) 困難です。ただし、Web サイトの委託条件を作成する際に、何を考慮する必要があるか、また何に注意を払う必要があるかについて、一般的な規定の概要を十分に詳しく説明しようと思います。

ウェブサイト開発の技術仕様

技術仕様は開発者向けに用意されています。委託条件は、顧客と請負業者の間で契約を作成する際に参照する必要があります。双方のポイントおよび期限の不履行または不履行に対する責任を規定する必要があります。しかし、(私の意見では) 技術仕様が作成される最も重要なことは、 プロジェクト開発プロセスのスピードアップ.

この例を分析してみましょう。

Web サイトのどこかにカレンダーが必要だと仮定しましょう。それは小さなことのように思えました。ただし、その機能を詳しく説明すればするほど、より早く結果が得られます。

ここで少し説明させてください。当月の曜日別の数字をシンプルに表示するカレンダーがあります。月をめくることもできます。月や年をめくることができるカレンダーがあります。

現在の日付を強調表示して、後者のオプション (月と年をスクロールする機能) が必要だとします。参照条件で、「サイドバーにカレンダーが必要」と記載がありました。最初のオプションが表示されます (単に今月の曜日ごとの数値が表示されます)。

私たちが持っているもの。請負業者は仕様を満たしていましたが、あなたはまったく異なるものを求めていました。すべてが調和しているように見え、誰も責めることはなく、対立はありませんが、最も重要なものは失われています 時間とお金.

これは単なる平凡なカレンダーの例です。

カレンダーの場合のように、処理に半日以上かかるような、より重大な処理をやり直す必要がある場合はどうすればよいでしょうか。請負業者は、あなたのプロジェクトを完了して新しいプロジェクトを開始できるときに忙しいのです。

したがって、より さらに詳しく各モジュールの機能を説明すると、より早く結果が得られます。双方がこれに関心を持つべきです。

技術仕様書は通常どのような点で構成されますか?

あなたが会社または企業のオーナーであると想像してみましょう。あなたの会社はあらゆる製品の生産と販売に携わっています。買い手がいるのです。販売者 (ショップやオンラインストア)、サービスセンター、製品の消費者と協力します。あるいは、そのような会社向けにリソースを作成していて、技術仕様を作成する必要があります。

どのような役割を担っているかに関係なく、Web サイトのデザインを作成するための技術仕様を作成する前に最初に行う必要があるのは、組織の構造、組織の役割、命名法、特性、および製品に関連するすべてのことを研究することです。そして会社。リソースで何が起こるかは、顧客が企業で起こっていることの本質をどれだけ深く理解しているかによって決まります。したがって、ここでのタスクは相互に行われます。顧客は企業についてできるだけ詳細に説明する必要があり、請負業者は何が起こっているのか本質を完全に理解する必要があります。

たとえあなた自身がプロジェクトを行う会社の技術仕様を書いているとしても、それをすべて紙に書き出すことをお勧めします。

ポイントごとに見ていきましょう。

説明

ここには、会社とその事業内容についていくつかの文を書くことができます。紹介のようなことをします。

誰に向けて - 対象読者:

潜在的な買い手

商品販売者（店舗、オンラインストア）

サービスセンター

パートナー（企業）

商品の消費者（すでに購入した人）

ウェブサイトが必要な理由:

企業イメージを向上させるため

売上を上げるには

お客様の利便性のため

企業向け

ウェブサイト – 名刺

オンラインストア

言語バージョン:

英語

サイトはいくつかの問題を解決する必要があります。したがって、私たちは目標と目的に向かってさらに前進します。

目標と目的

技術仕様のこのセクションでは、対象ユーザー全体を調べ、サイトがそのユーザーのために解決すべきタスクの範囲について説明します。

潜在的な製品購入者。

目標：より多くの購入者を惹きつけ、初めて購入するよう説得し、選択を支援します。

解決する必要がある問題:

製品に関する高品質で包括的な情報を提供し、追加サービス、保証、サービス、選び方など。

ショールームのご案内

小売ネットワークに関する情報を提供する

製品の選択と購入に関する問題について、企業の専門家による潜在的な購入者向けのオンライン相談を企画し、質問する機会を提供します。

したがって、対象ユーザー全体を調べます。また、製品販売者 (店舗、オンラインストア)、サービスセンター、パートナー (企業)、および製品消費者の目標と目的についても説明します。つまり、それぞれのサイトが具体的に何をすべきかということです。

次に、モジュールをリストします。

サイトの機能

機能をリストするには、何が必要かを決定する必要があります。

登録は必要ですか?

非公開セクションは必要ですか (登録ユーザーのみ)

フィードバックフォームは必要ですか?

等。等々。

Web 開発における最新のトレンドとアプローチ

ウェブサイト構築で急速に成長するためのアルゴリズムをゼロから学ぶ

機能の説明

現時点では、このサイトが誰のためのものであるか、どのような目標と目的を達成すべきか、そしてその追加機能はわかっています。

収集したすべての情報をシステムに取り込み、美しく整理する必要がある時代が来ています。車輪の再発明をせずにタスクを簡単にするために、同様のトピックに関するリソースを参照できます。彼らから何かを取り入れ、その機能や不便に思われる点を見て、試して、あなたのプロジェクトでそれを改善してみてください。原則として、技術仕様を作成する最初の段階で、同様のトピックに関するサイトを参照できます (経験がない場合は、参照する必要さえあります)。

メニュー項目から始めることをお勧めします。メインページを表示し、各訪問者が自分の情報をすぐに見つけられるようにする必要があります。そして訪問者は私たちの対象者です。メニューには多くの項目が含まれるため、ドロップダウンリストの形式になります。

まずは会社について教えてください。会社、会社の歴史、連絡先、レビューに関するページが含まれる場合があります。

当然、メニュー項目「製品」があり、サブ項目として「製品カタログ」、「リリース」、「製品レビュー」が存在するはずです。

一般的に、それをどのように説明すればよいか明確になれば幸いです。考えられるメニューの最終バージョンを紹介します。

会社について

会社の歴史

連絡先

製品

製品カタログ

製品レビュー

サービス部門

保証サービス

保証後のサービス

消費者へ

購入と配送

使用

サービスについて

店舗とオンラインストア

製品写真

よくある質問

サービスセンター

サービスセンターになるには

よくある質問

パートナー

協力への招待

よくある質問

メニューを整理したようです。ここで、各ページに何が表示されるか、そしてそれがどのように機能するかを説明する必要があります。さらに、おおよそのレイアウトも提供します。鉛筆で紙に描き、スキャンして技術仕様に添付することができます。ただ一つ言えるのは、デザイナーの想像力を制限せず、最も一般的な形でスケッチしてください。

ここで重要なことは、作業のロジックを説明することです。

動作ロジック

上の写真をもとに説明していきます。

上部(ヘッダー) はどのページでも同じままです。ニュースフィードはメインページにのみ表示されます。左側の二次ページには、現在いる項目のメニューサブ項目が表示されます (たとえば、「カスタマーサービス」ページにいる場合は、「保証サービス」、「保証後サービス」へのリンクが表示されます) ”）。したがって、これらのリンクをクリックすると、対応するページが表示されます。ここでは、左側のサブ項目の下に、オンラインコンサルタント (Skype、ICQ) に連絡するためのデータが表示されます。プロモーションとリリースのブロックは各ページに残ります。フッターはどのページでも同じように表示されます。

これは、作業の一般的なロジックを大まかに説明したものです。

さて、ウェブサイト開発に関する規約では、サイトの指定された各ブロックについて詳しく説明します。たとえば、「ニュースフィード」。

最新ニュース10件の「ニュースフィード」。各ニュースは、ニュースのタイトル、発行日、ニュースの短い冒頭 (4 ～ 5 行)、および「全文を読む」リンクで構成されている必要があります。「全文読む」リンクをクリックすると、ニュースページが表示されます。メインコンテンツの代わりに、あなたが見つけたニュースが表示されます。ニュースのタイトルと発行日も含まれます。左側にはニュースフィードも表示されます。過去数か月および数年間のニュースがアーカイブされます。つまり、当月のニュースの下に「（何月または何年）のアーカイブ」が表示されます。「（何月・何年）のアーカイブ」リンクをクリックすると、該当月・年のニュース一覧がドロップダウン表示されます。

各ブロックの動作を説明します。カレンダーの出来事を忘れないでください。そして最も重要なのは、製品カタログの仕事について説明する必要があることです。 ここで私はあなたにタスクを与えます:カタログがどのように機能するかをよく考えて説明してください。オプションを電子メールで送信してください。最優秀作品を掲載させていただきます。

他に何があればいいでしょうか？互換性を示すと良いでしょう。

互換性

Web サイト作成に関する当社の委託条件のこの段落では、どのオペレーティングシステムとどのブラウザで Web サイトが同様に美しく表示されるかを示します。どのバージョンで、どの言語で作成する必要がありますか。使用されているCMS。自分が何について話しているのかを実際に理解している場合は、指摘する価値があります。

これらの質問がわからない場合は、サイトが正しく表示されるブラウザを指定してください。残りは演奏者の良心に頼ってください。

結論

この記事では、これがまさに技術仕様の編集方法であり、それ以外の方法ではないことを示そうとしたわけではありません。これを実行すれば問題はありません。定性的な情報を作成する ウェブサイト開発に関する委託条件- これはもっと質問です経験。最初の数年間で誰もが適切な技術仕様を作成できるわけではありません。

この記事では、Web サイトのデザインとロジックを開発するためのサンプル技術仕様を構築するための例と原則、および注目に値する主なポイントを示したいと思いました。私がどこまで成功したかは、あなたのコメントから知りたいと思っています。

そして、タスクを忘れないでください！

あらゆるプロジェクトを開発するとき。この文書はどのように作成されますか? これについてはこの記事で説明します。

技術仕様 - それは何ですか?

プロジェクトの開発を開始する前に、まず計画を作成する必要があります。建設、起業家精神、住宅関連の仕事 - あらゆる労働分野では、適切な計画の策定が必要です。この場合、その仕事またはその仕事がどれほど複雑または深刻であるかは関係ありません。技術仕様の開発、そして実際には通常の行動計画がここで重要な段階です。

委託条件は、作業プロセスの両側、つまり請負業者と顧客に必要です。多くの場合、この二人の間で口論、対立、誤解が生じます。よく立案された行動計画は、各当事者のすべての義務を厳格に規制するのに役立ちます。

なぜ顧客は技術仕様を必要とするのでしょうか?

すでに述べたように、技術仕様の開発は、双方にとって有益な必要なプロセスです。雇用契約書。ただし、ここで、提示された文書が直接の顧客に必要な理由について話しておく価値があります。

注意すべき最も重要なことは、技術仕様は顧客によってのみ開発されるという事実です。これは一種の行動計画であり、サービスの提供に関する合意です。この文書の助けを借りて、実行者は自分の職務内容と、正確に何が求められているかを明確に定義できます。問題の文書は常に最高の品質と注意を払って作成される必要があります。したがって、顧客はすべての主要なテーマと要点を考慮し、矛盾する問題を回避する必要があります。文書が正しく作成されていれば、顧客はいつでも、不満を抱いている請負業者に契約の特定の条項を指摘することができます。

請負業者はなぜ技術仕様を必要とするのですか?

請負業者は、作業を開始する前に技術仕様のサンプルを受け取ります。作業者は文書のすべての点を注意深く読む必要があります。この手順は、顧客による操作を回避するのに役立ちます。したがって、多くの上司は、付託事項で議論されていない何かを従業員に要求する可能性があります。

契約者は、必要な事項と支払金額をすべて明確にしなければなりません。したがって、現金支払いが文書に指定されている点にのみ関連することを確認する価値があります。そうしないと、不注意な出演者がタダで仕事をしてしまう可能性があります。

したがって、演奏者は可能な限り頻繁に技術仕様のサンプルに注意を払う必要があります。そうすることで、不必要な問題や誤解を避けることができます。

文書の作成を開始します

書類の記入はどこから始めればよいですか? 作業の委託条件は、常に一般規定と目標から始める必要があります。一般規定には何が含まれますか? まず、小さな用語集です。もちろん、これは前提条件ではありません。ただし、文書の焦点が狭く、特定の用語がたくさんある場合は、小さな辞書を添付する価値があります。いずれにせよ、これは顧客と請負業者の間の相互理解に向けた新たな一歩となるでしょう。第二に、一般条項には契約当事者に関する情報が含まれていなければなりません。

委託条件の目的は何ですか? おそらく推測するのは難しくありません。したがって、どのような種類のプロジェクトが開発されているのか、なぜそれが必要なのか、そして最終結果をどのように達成できるのかを簡単に説明する必要があります。すべてのタスクと目標は、できるだけ詳細かつ明確に説明する必要があります。このアプローチは、契約当事者間の相互理解を確立するのに役立ちます。

要件と期限

作業を実行するための技術仕様には必ず、特定の要件と明確に設定された期限が含まれている必要があります。タイミングに関してはすべてが比較的明確です。ただし、ある程度の余裕を持って時間をかける方が良いことに注意してください。さらに、注文の実行速度が品質に影響を与えるべきではありません。請負業者が定められた期限に違反した場合、契約にはこの場合に対する一定の制裁を含める必要があります。

要件について教えてください。顧客は、すべての要件が特殊要件と機能要件という 2 つの主なタイプに分類されることを覚えておく必要があります。機能要件は、ある程度視覚的かつ比喩的なものです。これらは、顧客が見たいものの特定の画像、要素、スケッチです。特別な要件は厳密に規制されており、特定のタスクと実行方法が示されています。当然のことながら、特別なものが大幅に優勢になるはずです。そうしないと、演奏者は自分が何を望んでいるのかを完全に理解していない可能性があります。

責任と報告

技術仕様のサンプルには絶対に含めるべき 2 つの重要な要素について、もう少し詳しく説明する価値があります。私たちは当事者の責任と説明責任について話しています。これらの各要素は何を表しているのでしょうか?

特に委託条件が大きい場合は、段階的にレポートを生成することをお勧めします。一定の作業段階が完了したら、すぐに報告書を提出することができます（必須）。さらに、このようなシステムにより、パフォーマーを良好な状態に保つことができます。そうしないと、すべてを土壇場で行うことができるため、品質が非常に低くなります。

当事者の責任については何が言えるでしょうか? このような条項は必須ではないことにすぐに注意してください。しかし、多くの顧客は依然として、主な種類の罰金、罰則、制裁を規制する必要があると考えています。さまざまな障害。調達、輸送などの技術仕様書などの文書に責任の主な要素を示すことが望ましい。

技術仕様の作成

技術的な任務（供給、建設、輸送など）は、非常に有能かつ効率的に作成する必要があります。これは、第一に、当事者間の誤解によって将来の訴訟、紛争、紛争が発生しないようにするために必要です。そして第二に、単純な便宜のためです。すべての顧客が技術仕様を適切に作成できるわけではありません。多くの場合、この問題のために弁護士が雇われますが、そうすることにほとんど意味はありません。

いくつかの簡単なルールを覚えておくだけで済みます。

契約書は詳細かつ詳細でなければなりません（ただし、誇張する必要はありません。少なくとも 1 人の請負業者が要件に関する複数のボリュームのコメントを読みたいと思う可能性は低いです）。
契約は明確であり、混乱や不必要な情報が含まれていない必要があります。
課題はある種の教義であってはなりません。厳密に規制されているとはいえ、これは単なる指標であることを覚えておく価値があります。それが技術仕様であっても、メンテナンス木を植えたりとか。

上記で与えられたアドバイスはすべて、小さな部分言えることから。ただし、顧客にいくつかのガイドラインを提供することはできます。したがって、（保守または構築のための）委託条件をテンプレートに従って構築できます。このテンプレートをどこかから取得する必要はありません。したがって、サービス提供のための契約書を書くことがかなり一般的な作業である場合、自分用の決まり文句をいくつか作成することはそれほど難しくありません。

GOST、規制法や法的行為、現地法などの基準をチェックすることがいかに重要であるかを思い出してみる価値があります。

技術仕様とは何ですか? どのように行うのか、また何のために行うのか? 例、サンプル、ヒント、推奨事項。

誰かがあなたのことを完璧に理解してくれたら、それはどれほど素晴らしいことかと思われるでしょう。あなたはいくつかのフレーズを出しましたが、まさにあなたが想像していた通りのものがここにあります。残念ながら、そのようには機能しません。

情報認識の問題は永遠です。壊れた電話の効果よくある出来事。しかし、単にタスクの設定方法がわからない場合はどうすればよいでしょうか? はい、これも発生するので、何らかの方法で対処する必要がありますが、どうすればよいでしょうか? 設定したタスクの結果が期待どおりであることを確認するには、技術仕様を作成します。

技術仕様とは何ですか

技術仕様 (TOR) は、請負業者が提供する製品またはサービスに対する顧客の要件を含む文書です。簡単な言葉で言うと: 7 本の相互に直交する線と、赤色の線と無色の線が存在するように、この方法とあれが必要です (資料の最後にあるこのトピックに関するビデオを見ることをお勧めします)。

デザイン部門

この文書は、A4 1 ページまたは 1 冊全体を占める場合があり、すべてはそこに含まれるタスクと要望によって異なります。たとえば、小さなランディングページ (1 ページの Web サイト) または複雑なランディングページの技術仕様を書くことができます。ソフトウェア機械学習やその他の機能を備えています。

なぜ技術仕様が必要なのでしょうか?

実行者にタスクを割り当てるため。
最終的に何を取得したいのかを詳細に説明します。
仕事の順序に同意するため。
実装後の作業を評価して受け入れる。
...(コメントにオプションを追加してください)。

実際、技術仕様には上記のリストよりもはるかに多くの目的と利点があります。私個人にとって、技術仕様が解決する主なタスクは、期待 (私の期待) からの逸脱を最小限に抑えて、必要なものを実装することです。

技術仕様のおかげで、いつでも実装の期限、金額、記載された特性への準拠について問い合わせることができます最終製品またはサービス。

実際、これは顧客と請負業者によって作成される重要な文書です。当事者の罰則および義務が規定されている範囲で。多数の GOST があります。詳しくは Habré をご覧ください。

技術仕様の開発

たとえば、「大人向け」ゲームについて話している場合、開発のための技術仕様モバイルアプリまたはウェブサイトの場合、これは多額のお金が支払われる別の仕事になります。あなたは、通常は元または現在の最高技術責任者である人を引きつけ、その人に協力を依頼します。

ひげがあることはオプションです

プロジェクトやタスクの範囲に応じて、この担当者はあなたのすべての「要望」を収集し、それを技術用語に翻訳し、場合によってはスケッチ (おおよそどのようなものになるか) を準備して、完成したドキュメントを渡します。次に、この文書を実行者 (社内または外部委託先のチーム) に渡し、金額や期限について合意し、作業を開始します。

ヒント: CTO はチームに参加する必要があります。そうしないと、実装プロセス中に何かを見落とす可能性が高くなります。あなたにはすべてのことについて十分な知識がありません。技術仕様の作成に参加した人がそれをチェックします。

技術仕様は何で構成されていますか?

すべては選択したテンプレートによって異なります (もう少し詳しくテンプレート/例へのリンクをいくつか示します) が、技術仕様には基本的なブロックが含まれています。

プロジェクト/タスクの説明。完了する必要があるプロジェクトやタスクが何であるかを簡単に書きます。
目的と目標。プロジェクトの目標は何ですか?
要件。必要とされるデザイン、機能、技術。
作品の説明。何を、いつ、どのように行うのか。
管理と受け入れ手順。作品がどのように受け入れられるか、何が完了したとみなされるか。
アプリケーション。スケッチ、スケッチ、プロトタイプ。

作業の費用は通常、契約の別の付録に含まれますが、当事者が技術仕様自体に金額を指定する場合に発生します。

読書を中断して申し訳ありません。私の電報チャンネルに参加してください。記事の新鮮な発表、デジタル製品の開発、グロースハックなど、すべてがそこにあります。あなたを待っています！続けましょう...

技術仕様の例

技術仕様の開発は複雑なプロセスであるという事実にもかかわらず、非常に興味深いものです。あなたの仕事は、最終結果の図を再作成し、それを部分的に説明することです。

スマート TV アプリケーションの更新に関する私の規約の 1 つの例。より複雑で複雑な製品のタスクは、技術部門の同僚の助けを借りてまとめられました。ためらわずにチームメイトに助けを求め、できるだけ頻繁にチームメイトをプロセスに参加させてください。フィードバックをお忘れなく！結果が分からないまま、何かに努力と時間を費やすことほど悪いことはありません。その人のアドバイスがあなたの仕事にどのように役に立ったかを教えてください。そうでない場合は、一方的なゲームになります。

オンラインストア開発に関する規約

モバイルアプリケーション開発に関する規約

サイトの利用規約

サービス/アップデートに関する規約

さらにサンプルが必要な場合は、Google で検索してください。

主な推奨事項はこれを行うことです。問題は、母親の怠惰が誰をも支配しており、それに抵抗するのが簡単ではないことです。すべての意志の力を結集して技術仕様の作成を開始します。ただ書き続けるだけで、止まらないでください。「完璧に」うまくいかないことを心配しないでください。秘密をお教えしますが、そんなことは決して起こりません。ただ書くだけで、毎回どんどん良くなっていきます。

そうあるべきです

技術仕様を書くための私の最初の初歩は数年前に現れ始めました。私はデザイナーと協力して、クリエイティブを作成するという課題を設定しました。広告キャンペーン。私はそれを支離滅裂に望んでいたので、多くの時間と説明を無駄にすることになりました。時間の経過とともに、タスクの設定はある種の意味論的なブロックに変わり始め、さらに技術仕様のようなものになりました。

たとえば、「サイトのいいね！」ボタンというタスクの場合:

説明: 当社の Web サイトに「いいね！」ボタンを作成する必要があります。
目的と目標: ユーザーの関与、いいね数に基づく素材の発行/評価。
要件: 次のデザイン (例: 類似したものへのリンク)、機能 (どのユーザーも画像を評価して「いいね」を付けることができます。サイトシステムは「いいね」の数を考慮して素材の出力を変更します)、テクノロジー (デスクトップで利用可能)およびサイトのモバイル版）。
作業内容: ボタン配置を3パターン描画(完成日: 2017年10月1日)、いいねによる素材配布システムの開発(日付: 2017年10月14日)、機能テスト(完成日: 2017年10月16日) ）、リリース（日付：2017/10/17）
仕事の承諾: ユーザーが「いいね！」ボタンを押すと、システムがクリックをカウントし、資料の納品が変わります。
アプリケーション: スケッチ、スケッチ、同様の機能が動作するプロジェクトの例。

自分のタスクに必要な構造のセクションや部分は自分用に残しておきます。例えば、6 番目のブロック「アプリケーション」は機能要件で記述することができます。基本的なアドバイス: いずれにしても、技術仕様の構造に従ってタスクを説明します。こうすれば見逃すことはありません重要な点不必要な質問を避け、同僚の仕事を楽にします。

どうぞ

技術的なタスクとは何か、そしてそれをどのように実行するかを検討しました。明確かつ明確にタスクを設定し、自分の考えを他の人に伝え、追加の説明にかかる時間を節約できるようになりました。これでどうすればよいかおわかりいただけたと思います。