规范写作管理

我简直无法想象没有规范就可以编写软件。无论是粗略的还是高级的，规范对于向无知的程序员解释程序的功能是很重要的。

但是规范的问题在于，在整个软件开发周期中，它多少有些二等公民。当发展加速时，它就被忽略了。但是，当出现争议时，开发人员，测试人员和销售人员会争先恐后地找到规范以证明其根据。

一种或多种情况都会发生：

1. 规范无法恢复，没人知道规范在哪里
2. 规范的不同版本来自不同的来源。它需要很大的困难，找出哪个版本是最新版本，或是否有是可用的最新版本。
3. 规范不完整，所指文件的某些部分丢失了。

因此，规范管理非常重要，每个人只有一个单一的规范来源也同样重要。

您如何管理规格？我试图让所有人使用Google文档，但所有人都反对。每个人都对Microsoft Word太着迷和迷恋，他们认为Microsoft Word非常易于使用，易于插入图像，非常容易键入方程式等等。

如何使他们相信MS Word只是可怕的共享？

如何使他们相信MS Word只是可怕的共享？

不要浪费你的时间。

第一。规格应为纯文本格式（确实）并在源代码的控制下。使用Markdown或RST或其他轻型标记工具来生成PDF或HTML页面。纯文本。

第二。采取各种来源。合并它们。编写自己的最终文档。

当他们反对时，他们有两种选择。

1. 使用Google文档（或源代码控制工具）来编辑您的版本。

2. 继续向您发送更改，然后将其编辑，过滤和变形为最终文档。

我更喜欢＃2。有人需要“拥有”该规范。一群人（Wiki风格）导致了辩论，变革战争，附带文档以及离线对话等。

我认为这不是一个“工具”问题，而是一个“流程”（或缺乏流程）问题。

您可能已经有一个发布软件的过程（单元测试，集成测试，发布信，交付等），您还需要实现一个文档过程。

• 谁来编写规格？谁来更新或维护它们？
• 谁来审查规格？
• 谁来批准规格？建筑师，项目负责人，质量检查？
• 规格如何存储？
• 谁将确保不使用过时的版本？

明确需要某种控制。

需要对其进行版本控制和签名，并且此过程必须严格。

在太多的地方，签字被忽略了，这导致bun头打架。

只要可以追踪，位置就没关系

• 共享点
• 安全的备份共享驱动器
• 我已经看到一些地方使用其代码源控件！

但是更重要的是，您需要从所有相关人员那里买入，或者由1或2个人负责，例如管理文件和签字。项目经理。

MS Word非常适合创建规范。我们在SharePoint中管理我们的产品，同时还处理版本控制。如果您没有SharePoint或其他文档管理产品，可以使用Google Docs（您现在可以上传.doc / .docx文件，而无需将其转换为Google Docs格式）。或者像其他人建议的那样，您甚至可以将它们存储在源代码版本控制系统中（如果创建规范的人员可以访问该系统）。

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

您无法轻松比较版本控制系统中两个实例的不同之处。

因此，我不喜欢字规范。但是由于使用单词说明是一项政治决定，因此我们将这些列作为首页“历史信息”：

版本号（与产品版本有关），作者，日期，描述