我怎么写说明书？

Question

可能重复: 如何快速有效地编写功能规范？

有这么多的项目在半途而废--而且客户认为可以在不增加额外成本的情况下改变很多--我想开始编写规范。然而，我以前没有这样做过，对基本知识也不太了解。我从哪里开始？是否有经常使用的格式或模板来编写规范？是程序员写的，客户端写的，还是两者都写了？在哪里可以看到样品规格？欢迎所有关于如何开始的建议。

Answer 1

有完整的大学课程致力于需求工程，所以一个充分的讨论超出了这个问题的范围。不过，我可以向您指出一些资源，这些资源应该有助于您开始工作。我建议你在我所提供的资源和其他资源上仔细考虑一下，尽量把重点放在更具体的领域上。

在我的需求工程课程中使用的教科书是软件需求。我还买了一本书的增编，更多关于软件需求的信息。它们往往更多地涉及计划驱动和文档化方法中的需求，除了正式的需求规范文档之外，它们还讨论用户案例和用例。他们还介绍了需求激发技术以及远景和范围。这些书的作者有一个名为过程影响的站点，它也有一些资源，包括各种模板和指南。

如果您正在寻找更多要遵循的模板，我通常建议使用ReadySet模板。对于生命周期的不同活动和阶段，需要遵循不同的模板。一定要根据需要对它们进行适当的调整，以最适合您的开发过程。

至于谁开发规范，这取决于项目的结构，但通常是协作。我看到了客户知道他们想要什么的地方，他们与开发组织合作开发工作的远景、范围和需求规范。我还看到了客户拥有指定业务和操作需求的文档的地方，开发组织使用这些文档来开发工程师可以使用的系统需求。

Answer 2

如果您以前从未编写过规范，那么就从小开始。关于计划过程的简短文本，最重要的数据库表和/或类，以及一些粗略的屏幕布局，以及所有硬事实(导入/导出格式的描述等)。能创造奇迹。

当你过于专注于正确的工作时，就很容易陷入分析瘫痪，使用UML来充分扩展它，并且每一支箭头都有正确的提示。当你不知道有多少细节是足够的时候，规范就可以扩展到任何尺寸。

Answer 3

也许，对您来说，第一步是建立简单的更改控制。下一次当客户要求更改时，告诉他们这是一个未包含在原始估计中的更改。告诉他们，如果他们想要的改变，发送给你的详细要求在一封电子邮件，你会得到一个价格回来。

这样做的好处是，它清楚地表明正在发生变化。通过发送电子邮件，客户端承认这实际上是一种改变。

可能发生的情况是，这将导致客户机请求的更改较少。至少，这将使他们理解变更的范围，并明确地参与其中。

这取决于你，如果你选择要求更多的钱为改变，有些可能很简单，你会把他们免费，就像你现在这样做。不同之处在于，在工作结束时，你会得到一份关于你提供的额外价值的书面记录，这将帮助你赢得重复的事业。如果有更大的变化，一定要收费。