项目经理,你真的会撰写规格说明书吗?
2022-10-10对于非常关注技术的项目经理来说,最困难的事情就是选择省略哪些细节以及何时省略,在写规格说明书时,同样需要注意这个问题。
在规格说明书中突出重点,会让人们对任务更了解,并且持续开展下去。读过规格说明书后,事情要如何推进,在他们的头脑中会更加清晰,同时PM或团队其他人提出问题的质量也会提高,要达到这种效果就要努力找到对项目有重要贡献的人。
当然,对于复杂的对象模型或非常详细的界面,更高的复杂度是不可避免的。有些事情可能要花一些时间才能理解,但是必须要确定实际就是这样。比较常见的是,以复杂度作为借口,掩盖其撰写乏味或思想平凡。
撰写规格说明书的全部重点,就是以某种方式描述事物,而这种方法能够让人们通过最少的努力就能够理解说明书。在最糟糕的情况下,理解规格说明书所花的时间,会比设计它所花的时间还长。
虽然撰写规格说明书的的标准非常主观,但为了更好的描述项目任务,有一些事项还是要尽量注意的——
(1)从其他规格说明书那里借用良好的说明内容(即使是其他人写的)
适当使用超文本,如果需要可以从网站上摘取有用的概要——团队领导应该鼓励这样做,你不需要描述或说明所有的事情。
(2)避免行话和模糊不清的语言
除非你确定使用行话对大家有帮助,否则就别用。或者,必须要用的话,可以通过把宏观概念分解,转变成不易产生歧义的知识,同时消除多余的语言堆砌,来减少刻意把事情概念化可能会引起的困难。
(3)备有旧的规格说明书
当你受困于不知如何才能最好的表达概念或者图示说明时,旧的规格说明书就是很好的参考资料,当你看到别人写了一份优秀的规格说明书时,也需要借鉴。
(4)撰写规格说明书时,心中要有特定的读者群
即使是10人的团队,也可能有4-5人会极度依赖规格说明书。在这些人之中再加上一个精明的人,但他不在团队内,对你正在使用的特定技术不熟悉,那你要怎么对他描述困难的概念?
(5)这是参考资料还是规格说明书?
规格说明书通常不需要完整的API参考资料,或者描述每个实例或可能的行为。把焦点集中在10-15个常用或最重要的案例上,并且以另一份独立的文件把剩余的部分都列出来(不用太详细),这样是完全合理的。
(6)深入研究之前,从高层次来描述复杂的算法
考虑如何以分层次的方法来说明,也许是最快的学习方法——即使对精明的人也是如此。至少,良好的摘要和概述会长久使用。
- 上一篇:优秀项目经理必备的9种软技能
- 下一篇:你会对项目进行波浪式规划吗?