ツールには何が必要ですか？ おそらく、すべての要件は一言に集約されます-利便性。 結局のところ、これが不都合な場合は、何かをする非常に良い理由が必要です。 しかし、同僚に仕様書の作成を楽しんでもらいたいのです。 たとえば、プログラミングから。
個人的に、いくつかの要件があります。
- 検索の便利さ。 キーワードで正しい仕様を見つけることができる必要があります。 または、そのような仕様がないことを確認してください。
- 編集の便利さ。 仕様を記述するプロセスが単純であればあるほど、同僚は喜んでそれを行います。
- 読みやすさ。 仕様の読者はライターよりも広くなることが事前にわかっています。 これらは、これらの仕様に従ってコーディングするプログラマー、プログラマーがエンコードしたものをチェックするテスター、さらにはプログラマーができるだけ早くコーディングするものを見つけたいクライアントです。
オプション1. Microsoft Office。
一見、シンプルなソリューション。 Wordの使用方法は既に知っています。Wordはすべてのプログラマーによってインストールされるため、問題はありません。
適切な仕様を見つけやすくするために、それらの保管場所を集中管理する必要があります。 プロジェクトの数に応じて、サブフォルダーを使用してサーバー上にPROJECTSフォルダーを作成します。 ここでドキュメントを追加します。
時間が経つにつれて、私たちは典型的な仕様の設計テンプレートを思いつきました。 いいえ、これは仕様にあるべき20ポイントの標準コンテンツではありません。 神は禁じた。 さまざまなセマンティックパーツのデザインスタイルについて説明しました。
- 仕様タイトル：トピック、著者/日付/レビューア
- 顧客からの元の文言/要件
- テスター向けの注意事項
- 開発者向けの注意事項-機能仕様のテキストで、何かに注意を向ける必要がある場合。 これが完全に技術仕様である場合、たとえば、サーバー上のトリッキーな機能の実装の記述、またはそこにあるアーキテクチャの場合、通常のスタイルを使用します。
- スクリプト。
有用なことが判明しました。 ドキュメントはとても面白く、カラフルで、読みやすいものになりました。 また、テキストを読むだけでなく、見た目だけで適切な部分をすぐに見つけることができます。
後に、あるドキュメントから別のドキュメントへの相互参照が必要であることが明らかになりました。 さいわい、Wordにはこのための比較的便利なメカニズムがあります。 ドキュメント内およびドキュメント間のリンクを作成できます。 時間が経つにつれて、ドキュメントが表示されるようになりました。ポータルは、主に他のドキュメントへのリンクで構成されています。
時には（より正確には、かなり頻繁に）インターフェースのスケッチを仕様に挿入したり、UMLダイアグラムを挿入する必要があります。 Visioでそれらを描画し、仕様に挿入します。 問題は、Visionファイル自体をどこに保存するかです。 トリッキーなルールを考えてみましょう-関連ファイルを保存するために、ドキュメントのような名前のフォルダーを作成し、そこに追加のマテリアルを入れます。
要約：
- 私たちのプロジェクトの半年以上の作業で、約30の完全な仕様が生成されました。 それらは、アナリスト、主要な開発者、およびいくつかの普通の開発者によって書かれました。
- 必要なもの：
- 記述仕様の数に応じた、MS Officeパッケージのプログラム。
- ドキュメントを保存するためのサーバー上のパブリックフォルダー。
- 仕様の設計と保管に関する規則が作成されました。
長所：
平坦なトレーニング曲率（（c）Golubitsky）。 プロセスを開始するには、強い意志以外の努力は必要ありません。 原則として、すべての必要なツール-オフィスプログラムとネットワークドライブ-はすでに利用可能です。 ドキュメントを操作するスキル（もしあれば）はすべて保持されます。
短所：
- コラボレーションは困難です。 誰かが仕様を開いた場合、他の誰も現時点で仕様を変更できません。
- 変更履歴はありません。 仕様を最後に読んでから何が変更されたかを理解するのは困難です。 高度なWordレビューツールを使用しても、ドキュメントの編集を1回だけ追跡できます。 しかし、そうであっても、下線の取り消し線と行注釈のために文書は読めなくなります。
- 検索は難しいです。 適切な仕様、およびその中の適切な部分を見つけることは困難です。 少なくともおおよそ、ドキュメントの名前を覚えて、50人の仲間の中からそれを見つけようとする必要があります。 はい、Windowsにはファイル検索があるようです。 しかし、彼はオフィス文書の検索を開始するために、たくさんのシャーマニズムな行動をする必要があります。 そして、30台すべての開発者のコンピューターでそれを繰り返します。
要約：
記述されたツールキットは、仕様を実際に試し始めたばかりの場合には十分です。 約5人の開発者がいる非常に小さなプロジェクトで使用できます。 複数のプロジェクト、複数のチームがあり、最も重要なことは、すでに仕様の魅力を味わっており、さらに多くのものが必要な場合は、より高度なツールが必要です。 私たち自身のために、Wikiで見つけました。
（ パート2. Wiki-手元にあるすべてのものを参照）