我被问到（在我刚刚开始工作的地方）为一些新功能创建简单的规范，这些功能将被添加到现有的注册系统中。我需要一些帮助，因为我以前从未这样做过。 以下是两个显示当前工作流程和新工作流程的图表。
我知道他们可能有点模糊，但这是基本上发生的事情。 我们正在向现有的Windows应用程序添加新的导入表单。 我们正在通过添加将搜索的搜索按钮来修改现有表单 搜索并填充由ocr读取的数据。
我是一名新开发人员，而且我在编写一般文档方面非常糟糕，但我想对此进行改进。也许一些关于如何写这样的东西的例子会有所帮助。我用谷歌搜索了一些例子，但我发现的大多数都是在创建一个全新的系统。我需要一些东西来展示如何编写一个用于修改现有系统的东西。
这是我对规范的尝试。也许有人可以批评它。至少那时我会知道我需要改进什么。 http://cid-ddb3f6a92ec2b97e.skydrive.live.com/self.aspx/.Public/Specs.docx
由于
答案 0 :(得分：5)
答案 1 :(得分：3)
对于任何文件：首先要考虑你为什么写它 - 谁会读它，他们需要知道什么？多少细节合适？另外几个一般性的想法
如果可能有用，那么请考虑一下您正在编写的信息来源。其中一个结果可能是您确保可以验证您所写的内容。例如，如果信息来源是一个人，特别是对于IT文档，它可能是一个非IT人员告诉你的东西，那么你可能会非常小心你如何呈现一些信息，以便“来源”也可以理解你是什么话说。
还要仔细考虑当前文件之后的内容。例如，可能会根据您所写的内容编写测试计划吗？这可能会导致您在表格中显示信息，这些信息很自然地扩展到测试用例。
所以对你的具体问题。 “spec”是什么意思？您提供的工作流程不足以让用户查看并同意“是的，这就是我想要的”。有人写一些代码是不够的。我想你可能需要几份文件。
1）。某种要求的文件。您可能使用的一种格式是故事板。这关注于用户可以看到和做的事情。确切地说，每个屏幕上显示的数据。如果存在显示的内容的计算，您可能需要有附录来描述这些。用户和开发人员都会阅读此文档。可以使用Powerpoint或Word。
2）。从那里你可以得到一些明确的数据模型。逐项，逐项。数据类型，大小，验证等。我可能会使用日期建模工具，或UML或只是一个电子表格。主要受众是开发人员，但理想情况下，用户（或商业中介）可以验证详细信息。 [如果您没有业务分析师，您可能 业务分析师:-)]
3）。更具技术性，是针对第1项和第2项的开发人员的规范。实现的分解。您正在使用的模块，包，类或任何名称。转换，算法和计算的定义。更技术性的文档。我会使用UML，但任何精确的捕获形式都可以。这是我们可能真正深入研究工作流程中某些详细框的含义。
正如已经观察到的那样，一般来说，我们还需要确保开发人员提供非功能性需求，例如安全性和数据量。在你的情况下，这可能是有意义的，所以你可能现在可能不需要它......在你可能的其他生活中，所以至少有一个衬垫来提醒你的未来可能是一个好主意
答案 2 :(得分：1)
这些是规范的良好开端。
我会通过创建你希望windows应用程序看起来像的模拟屏幕截图来添加它们。
除此之外，您还可以添加每个数据字段的详细信息以及允许的值。
包括您可以想到的任何异常的详细信息，以及您希望如何报告错误。
您可能还想考虑需要哪种报告和安全/审核，因为这些需要包含在设计中。
最后，值得与开发人员坐下来讨论整个过程，完成每个步骤，因为我确定需要进一步的细节。
答案 3 :(得分：1)
底部的一些步骤有点罗嗦。尝试将它们分开并确保单词IF永远不会出现。应使用钻石指定IF，并根据条件分割流路径。
