小白如何写需求文档

Posted 2020-11-04 lclc

上学期在跟着网站里的学长学姐学了许多东西，假期我们需要自己做一套网站签到OA出来，昨天刚刚把需求文档定下，万事开头难，我把迈出的第一步记录下来，也给第一次写文档的小伙伴一些建议。

第 一次写，难免无从下手，在网上查找了大量的需求文档范例，网上也有模板，不过模板上东西很多，有些我还并不太了解，也不太适用于自己我们要做的OA. 既然是需求文档，那就应该根据项目实际情况去写文档，所以我们在写文档时注重的是我们需不需要，而非和模板是否符合。接下来，是我们写文档的步骤。

1、定框架

首先要把整篇文档需要的内容，大标题，子标题记录下来，即做成目录的形式。如图，这是我跟模板内容选出来的符合我的需要的，加以整理。

2.书写文字部分

在定好框架之后，我开始写引言、和环境需求、非功能需求的部分，这些相对好写，耗费时间也不长，可网上搜索资料，可和搭档讨论，这里也很重要，要考虑多方面的问题。

3.定功能、写功能需求

开 始写功能需求之前，首先要大家要把目标功能定下来，每个功能的细节也要讨论到，讨论过程中要做记录手稿，全靠脑袋是记不住的。这一步很重要，千万不可以想 到一个功能添加一个，因为各功能之间会有关联，临时起意的功能很容易导致各功能之间存在矛盾或重复，最后写出来也会让人看不懂。其次注意功能要切合实际， 不能想怎样就怎样，要考虑到后期实现的可能性，以及用户体验感，这个功能是否必要或多余。

功能定好之后，就可以愉快的总结出来，制成表格 啦。每个功能要说明名称、编号、操作流程（即如何使用此功能）、和备注。若功能分类较多，要注意命名时的简洁易懂，分类清晰，会给后面代码的编写带来很大 的方便。操作流程也是尽可能详细，记录下对每个功能如何实现的详细想法，同样是为编写代码省去麻烦。

4.数据库建表、画ER图

这步需要时间较长。我们是先画出ER图，再根据图建表，会快很多。

画图之前要搞清楚需要哪些数据，又有哪些表，以及表与表之间的关系。画图时，以矩形作为表名，椭圆形为表的属性值，菱形代表两表之间的关系。

有图之后，建表就可以根据ER图来做，两者要保持一致。

表的内容包括，列名、数值类型、长度、是否为空、主外键设置等

5.补充修改细节

在上面四步都做好之后，整篇文档基本成型了。最后我们又多次浏览文档，尤其是功能，检查实现功能的逻辑是否合理。一定要大家一起讨论，自己一个人是看不出问题的。如果有学长学姐，最好请教一下他们，他们会给出很棒很好的建议，并且指出错误，可以进一步完善文档。

以上就是我们在写需求文档时的步骤。如果有不当错误之处，希望您能给小白指明，这样小白才能改正错误、获得进步。谢谢您的阅览！