文档编写随笔

  在编写文档过程中,首先应确认阅读对象。当然文档的阅读对象可能不局限于某一个群体。所以,我们需要根据阅读对象对所编写的内容进行模块化、针对性进行书写。下面我们以需求文档为例,来进行讲解。

  首相,需求文档的大致格式如下:

  1、目录

  2、概要说明

  3、项目背景说明

  4、需求概要说明

  5、根据需求所设计的内容

    1)系统架构需求

    2)功能需求

    3)性能需求

    4)其他需求

  6、总结

  首先,标题1、2、3、4、5.1、基本可以说是领导比较关注的内容。所以,这些模块要达到思路清晰、简要明了。市领导看完就能够马上理会你所希望表达的信息。

  标题5整个内容是真正涉及到研发管理人员、研发人员、实施人员等角色较为关注的内容。这里就需要做到,层次结构清晰,内容涵盖全面。做到由粗到细、内容结构有序,使这类人员能够对你根据需求所设计的内容做到清晰明了。后续可对你所编写的内容提出问题或修改意见。

 

posted @ 2019-04-29 14:18  stevenG  阅读(84)  评论(0编辑  收藏  举报