スペックライティング管理

仕様なしでソフトウェアを書くことは想像できません。それがどんなに大雑把であろうと高レベルであろうと、スペックはプログラムの機能が何であるかについて無知なプログラマーに説明することが重要です。

しかし、スペックの問題は、ソフトウェア開発サイクル全体でいくらか2番目の市民であることです。開発がスチームを拾うとき、それは無視されます。しかし、論争が発生すると、開発者、テスター、および販売担当者は、彼らの根拠を正当化するための仕様を見つけるために争います。

1つ以上のシナリオが発生します。

1. 仕様を復元できません。仕様がどこにあるか誰にもわかりません
2. 仕様の異なるバージョンは異なるソースから出てきます。どのバージョンが最新バージョンであるか、または利用可能な最新バージョンがあるかどうかを見つけるのは非常に困難です。
3. 仕様は不完全であり、参照するドキュメントの一部が欠落しています。

したがって、スペック管理は重要であり、誰もが単一のスペックのソースしか持っていないことも同様に重要です。

スペックをどのように管理しますか？私は誰もがGoogleドキュメントを使用できるようにしようとしましたが、誰もが反対しました。誰もがあまりにも愛着があり、Microsoft Wordに夢中です。MicrosoftWordは、非常に使いやすく、画像を挿入しやすく、数式を入力するのも簡単です。

MS Wordが共有するのがひどいことを彼らに納得させるには？

MS Wordが共有するのがひどいことを彼らに納得させるには？

時間を無駄にしないでください。

最初。仕様はプレーンテキスト（実際に）で、ソースコード管理下にある必要があります。使用Markdownを、またはRSTまたはいくつかの他の軽量のマークアップツールはPDFまたはHTMLページを生成します。プレーンテキスト。

第二。さまざまなソースを入手してください。それらをマージします。独自の最終文書を作成します。

彼らが反対するとき、彼らには2つの選択肢があります。

1. Googleドキュメント（またはソースコード管理ツール）を使用して、バージョンを編集します。

2. 編集、フィルター、最終文書へのモーフィングによる変更を送信し続けます。

私は＃2を好みます。誰かが仕様を「所有」する必要があります。そして、たくさんの人々（wikiスタイル）は、討論、変更戦争、サイドドキュメント、オフラインの会話などにつながります。

「ツール」の問題ではなく、「プロセス」（またはプロセスの欠如）の問題だと思います。

おそらくすでにソフトウェアをリリースするプロセス（単体テスト、統合テスト、リリースレター、配信など）があり、ドキュメントプロセスも実装する必要があります。

• 誰がスペックを書こうとしているのですか？それらを更新または保守するのは誰ですか？
• 誰が仕様をレビューしますか？
• 誰が仕様を承認しますか？建築家、プロジェクトリーダー、QA？
• スペックはどのように保存されますか？
• 古いバージョンが使用されていないことを誰が確認するのですか？

ある種の制御が明らかに必要です。

バージョン管理とサインオフが必要であり、このプロセスは厳密である必要があります。

あまりにも多くの場所で、サインオフは無視され、これはパンの戦いにつながります。

追跡できれば場所は関係ありません

• 共有ポイント
• 安全でバックアップされた共有ドライブ
• 一部の場所でコードソース管理を使用しているのを見てきました。

しかし、より重要なことには、関係するすべての人から1人または2人の人からバイインする必要があります。たとえば、ドキュメントとサインオフの両方を管理する責任があります。プロジェクトマネージャー。

MS Wordは仕様を作成するのに完全に適しています。私たちは、バージョン管理も行うSharePointで管理します。SharePointや他のドキュメント管理製品が手元にない場合は、Googleドキュメントで問題ありません（.doc / .docxファイルをGoogleドキュメント形式に変換せずにアップロードできるようになりました）。または、他の人が提案したように、ソースコードのバージョン管理システムにそれらを保存することもできます（仕様を作成する人がそのシステムにアクセスできる場合）。

 > How to convince them that MS Word is just terrible for sharing?

バージョン管理システムの2つのインスタンスの違いを簡単に比較することはできません。

そのため、私は単語の仕様が好きではありません。しかし、これは単語仕様を使用するという政治的な決定であるため、これらの列の最初のページに「履歴情報」があります。

バージョン番号（製品バージョンに関連）、作成者、日付、説明