书写功能规格说明书的注意事项总结

声明：此文本只是作为个人初次写功能规格说明书的总结之用，应该使用批判的眼光看待，
仅供参考。


1，在书写功能规格说明书的时候，在逐条进行罗列的时候，应该使用word的编号功能，否则
会给后期维护带来很大的工作量。


功能规格说明书只是说明功能，不应该涉及实现细节和相关UI。


2，所以不要出现，点击某个按钮，或者是点击某个图标会怎么样，可以说提供了什么功能。


3，在描述界面的时候，应该把界面上要显示的字段信息进行一一罗列出来，但是不应该涉及
到某个字段放在某个字段的相对位置，或者在界面上的绝对位置。只说要展示的信息即可。


4，对于某个具有功能的信息，比如说顶一下和踩一下，应该进行说明是展示信息的，还是
同时也提供功能。


5，对于在同一个界面中显示很多相同的对象，同时又要进行区分的情况下，应该写，可以对
不同的对象进行区分，而不应该涉及怎么样进行区分的细节。


6，对于参与者应该要事先定义好，进行统一命名。


7，对于涉及到列表多条信息的时候，应该将排序的方式写明白。每个选项上显示的信息也应
该一一罗列。


8，在展示信息的时候，对于可能存在歧义的数据，应该要说明，比如说展示活动的时候的人数
是活动规定的参加人数呢，还是实际上活动的参加人数呢？


9，在事件流中或者是异常流程中，对于网络异常，或者图片需要异步加载等通用和常识就不
需要书写了。


10，展示信息的信息的界面都是没有事件流的。


11.对于编辑的信息，应该具有规则约束，比如说只能填写汉字之类，长度不超过100之类。或者是提供默认值。


12，对于具有事件流的整个过程，应该要考虑到所有的case和异常情况。


13，对于提供分页显示功能的界面，应该只写要求进行分页显示，但是不应该在说明书中规定
每页显示的条数，因为这是不确定的。