程序员文档修炼之路(一)系统操作文档


老刘按:做为程序员,绝不是单纯写代码,快速出文档是第一件必需的武器,基本的图片处理和初级文档编辑能力是每个程序员都过关的,初级文档编辑不只是打字和粘贴图片


1、 封面
封面大概写上文档名称,标注好著作人(个人名称或公司名称)及编写日期 

2、 目录
最好使用word自动生成的目录

老刘按:文档目录不要手工创建,一定要用自动创建和更新,否则一改就麻烦死了
  至少要有个封面和目录


3、综述和概览
让用户知道这个系统是个什么东西

4、系统整体架构

5、模块介绍
模块主要功能的介绍

6、前端用户操作介绍

7、后台管理操作介绍

8、系统级别的注意事项和异常处理
比如系统死了咋办

编写中注意:
系统性的说明,要注意整体条理性,和关键点的说明,要有相应的注意事项说明
要有点逻辑和条理性,不能就这么几单流水帐了事 


1、至少要有个封面和目录
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值