通俗/正式两种风格的文档,哪种更利于以后的发展?

tylanbin 发布于 2016/05/06 18:02
阅读 374
收藏 0

小弟第一次在OSChina提问,还请过来人赐教。

现在在一家小公司工作,做的是类似OA的项目。一般主要是写代码和处理疑难问题,当然也会写各种文档(小地方,大家都懂,虽然我及其不擅长写东西)。每次在写需要给老板看的文档时,我个人总感觉正式一点比较好,包括文档的格式、以及一些用语等等,但是每次写出来之后,领导总说写的通俗一点更好(后边会举个例子),然后就是改改改。一直很纠结,不知道怎样才更有利于日后发展,所以提出此问题,希望大家能给点支持。


举个栗子:

  • 原文:
    1. 开发计划概述
      • 功能模块1
      • 功能模块2
      • ...
    2. 功能模块1
      • 功能描述
      • 功能点
        • 功能点1
        • 功能点2
        • ...
    3. 功能模块2
    4. ...
  • -----------------------
  • 修改后:
    1. 我们准备开发什么
      • 功能模块1描述
      • 功能模块2描述
      • ...
    2. 我们准备怎么进行开发
      • 功能模块1
        • 步骤1
        • 步骤2
        • ...
      • 功能模块2
      • ...
加载中
0
ZeRur
ZeRur
根据个人经验 除非你写的是PRD RP / README / ApiDoc 否则一般开发计划开发一旦完毕就很少有人看了 一般开发就更不看了直接就撸代码 debug 而领导一般比较喜欢通俗一点的
tylanbin
tylanbin
感谢建议~
0
成都小高SEO
成都小高SEO

一目了然,通俗易懂,层次分明,

www.vpincha.cc

返回顶部
顶部