2

バックグラウンド

私はハードウェア開発エンジニアリングのバックグラウンドを持っています。私たちの詳細な仕様は、ドキュメント (通常は MS Word) の最後または最初に表として改訂履歴が含まれていました。これらの仕様は、回路図や基板レイアウト ファイルなどのハードウェア設計成果物を保存するために使用される管理システムとは別のドキュメント管理システムに保存されました。ドキュメント管理システムが仕様に使用されず、代わりにファイル名にドキュメントのリビジョン番号が含まれている場合がありました。これは、誰かがダウンレベルのリビジョンでドキュメントを変更し始めることを考えると、最適ではない解決策のように常に感じていました。

質問

DVCS (Git) を使用するソフトウェア プロジェクトの作業を開始しました。MS Word ドキュメントの代わりに、Markdown を使用して仕様/ドキュメントをテキスト ファイルとして作成する予定です。仕様やユーザー ドキュメントなど、すべてを DVCS に含めるというアイデアが気に入っています。ただし、仕様とドキュメントを実際のコードと同じリポジトリに保存するべきではないようです。これは私の質問に私を導きます：

  1. 仕様/ドキュメントはコードとは別のリポジトリに保存する必要がありますか?
  2. 仕様/ドキュメントごとに個別のリポジトリが必要ですか?
  3. ソフトウェア エンジニア/コーダーは、通常、DVCS が改訂履歴を持つ機能を提供することを考えると、仕様とドキュメントに改訂履歴を記録しますか?
4

2 に答える 2

2

  1. 広く利用されていないあいまいな形式で仕様を保存しないでください。ツールは、ドキュメントの形式を決定するべきではありません。ドキュメントは、グループ外の単語しか知らない人が使用する必要がある場合があります。

  2. はい、仕様/ドキュメントはコードとは別のリポジトリに保存する必要があります。コード リポジトリの管理には、ドキュメント リポジトリとは異なる要件があります。ドキュメント リポジトリで同じ並列組織構造 (つまり、同じプロジェクト名、階層など) を使用できるため、関連するドキュメントを簡単に見つけることができます。

  3. 仕様/ドキュメントごとに個別のリポジトリを作成しないでください。組織は、コード リポジトリの組織を反映する必要があります。すべてのプロジェクトのすべてのコード ファイルに個別のリポジトリがありますか?

  4. はい、リポジトリに関係なく、仕様/ドキュメントに改訂履歴を入れるのが一般的です。ドキュメントは組織全体で使用する必要がある場合があり、組織外の人はソース管理にアクセスできない場合がありますが、変更を加える必要がある場合があります (組織内の誰かが管理/チェックインできます)。

より一般的には、多くの場合、ドキュメントはさまざまな会社の部門間で使用する必要があります (つまり、リポジトリにアクセスできない/リポジトリに精通していない UI チーム、営業、マーケティングによってレビューされます)。

于 2009-12-27T15:01:24.423 に答える
0

企業の世界では、1. と 2. は、ドキュメントとコードの作成/アクセス/承認に必要なセキュリティ モデルを処理するリポジトリの能力に依存します。3. については、該当する場合は、改訂の背後にある詳細な理由を常にドキュメントに含める必要があります。

于 2009-12-27T14:50:41.873 に答える