代码之家  ›  专栏  ›  技术社区  ›  Matthew Rankin val

功能规范应该存储在哪里,如何跟踪它们的修订历史?[关闭]

  •  2
  • Matthew Rankin val  · 技术社区  · 15 年前

    背景

    我来自硬件开发工程背景。我们的详细规范包含一个修订历史,作为一个表格,放在文件的末尾或开头,通常是MS Word_。这些规范保存在文档管理系统中,与用于存储硬件设计可交付成果(如原理图和电路板布局文件)的管理系统分开。有时文档管理系统不用于规范,而是包含文档修订号的文件名。考虑到有人会开始用较低级别的修订版修改一个文档,这总感觉像是一个次优的解决方案。

    问题

    我已经开始开发一个使用dvcs(git)的软件项目,并计划使用markdown而不是ms-word-docs将规格/文档作为文本文件写入。我喜欢在DVC中包含所有内容的想法,包括规范和用户文档。但是,似乎规范和文档不应该与实际代码存储在同一个存储库中。这就引出了我的问题:

    1. 规范/文档是否应与代码存储在单独的存储库中?
    2. 每个规范/文档是否应该有单独的存储库?
    3. 软件工程师/编码人员通常会在他们的规范和文档中添加修订历史记录,因为DVC提供了修订历史记录的能力?
    2 回复  |  直到 15 年前
        1
  •  2
  •   Larry Watanabe    15 年前
    1. 不要将规格以一些不常见的模糊格式存储。该工具不应指定文档的形式。这些文档可能需要由您所在组之外只熟悉Word的人使用。

    2. 是的,规范/文档应该与代码存储在单独的存储库中。管理代码存储库的要求与文档存储库不同。您可以在文档存储库中使用相同的并行组织结构(即相同的项目名称、层次结构等),这应该使查找相关文档变得足够容易。

    3. 每个规范/文档不应该有单独的存储库。组织应该反映代码存储库的组织。对于每个项目中的每个代码文件,是否都有单独的存储库?

    4. 是的,通常在规范/文档中放置修订历史记录,而不管存储库是什么。文档可能需要跨组织使用,组织外部的人员可能无法访问源代码管理,但可能仍需要进行更改(组织中的某个人可以管理/签入)。

    更常见的是,文档通常需要跨不同的公司部门使用(即,由没有访问/熟悉存储库的UI团队、销售人员、市场营销人员审查)。

        2
  •  0
  •   fupsduck    15 年前

    在企业界,1.2。取决于存储库处理创建/访问/批准文档和代码所需的安全模型的能力。3。如果适用,您应该在文档中始终包含修订背后的深入推理。