Don't store the specs in some obscure format that isn't widely available. The tool should not dictate the form of the document. The documents may need to be used by someone outside your group who is only familar with word.
Yes, the specs/docs should be stored in a separate repository from the code. Managing a code repository has different requirements than a document repository. You can use the same parallel organization structure (i.e. same project names, hierarchy etc.) in the document repository, which should make it easy enough to find the relevant documents.
There should not be a separate repository for each spec/doc. The organization should reflect the organization of the code repository. Do you have a separate repository for every code file in every project?
Yes, it is common to put a revision history in the specs/documents regardless of the repository. Documents may need to be used across organizations, and people outside the organization may not have access to the source control but may still need to make changes (which someone in your organization can manage/check in).
More commonly, often the documents need to be used across different company departments (i.e. reviewed by the UI team, sales, marketing who don't have access to/familiarity with repositories).
In the corporate world, 1. and 2. depends on your repository's ability to handle the security model required for creating/accessing/approving the documents and code. For 3. when applicable, you should always include in your documents the in-depth reasoning behind the revision.
发布评论
评论（2）
不要以某种未广泛使用的晦涩格式存储规格。该工具不应规定文档的形式。这些文档可能需要由您的团队之外仅熟悉单词的人使用。
是的，规范/文档应该存储在与代码不同的存储库中。管理代码存储库与管理文档存储库具有不同的要求。您可以在文档存储库中使用相同的并行组织结构（即相同的项目名称、层次结构等），这应该可以很容易地找到相关文档。
每个规范/文档不应该有一个单独的存储库。该组织应反映代码存储库的组织。您是否为每个项目中的每个代码文件都有一个单独的存储库？
是的，无论存储库如何，通常都会在规范/文档中放置修订历史记录。文档可能需要跨组织使用，组织外部的人员可能无权访问源代码管理，但可能仍然需要进行更改（组织中的某人可以管理/签入）。
更常见的是，这些文档通常需要在不同的公司部门之间使用（即由无法访问/不熟悉存储库的 UI 团队、销售、营销人员进行审核）。
Don't store the specs in some obscure format that isn't widely available. The tool should not dictate the form of the document. The documents may need to be used by someone outside your group who is only familar with word.
Yes, the specs/docs should be stored in a separate repository from the code. Managing a code repository has different requirements than a document repository. You can use the same parallel organization structure (i.e. same project names, hierarchy etc.) in the document repository, which should make it easy enough to find the relevant documents.
There should not be a separate repository for each spec/doc. The organization should reflect the organization of the code repository. Do you have a separate repository for every code file in every project?
Yes, it is common to put a revision history in the specs/documents regardless of the repository. Documents may need to be used across organizations, and people outside the organization may not have access to the source control but may still need to make changes (which someone in your organization can manage/check in).
More commonly, often the documents need to be used across different company departments (i.e. reviewed by the UI team, sales, marketing who don't have access to/familiarity with repositories).
在企业界，1. 和 2. 取决于您的存储库处理创建/访问/批准文档和代码所需的安全模型的能力。对于 3. 如果适用，您应始终在文档中包含修订背后的深入推理。
In the corporate world, 1. and 2. depends on your repository's ability to handle the security model required for creating/accessing/approving the documents and code. For 3. when applicable, you should always include in your documents the in-depth reasoning behind the revision.