编写技术文档

编写项目文档

技术性写作的7条规则

  • 分两步编写: 先聚焦于思想,然后审查和修整文档
    • 先关注内容然后才是风格和清晰性
  • 以读者为目标:谁将读这个文档?
    • 在开始编写之前,要了解面向的读者
  • 使用简单的风格:保持简单明了,使用良好的语法.

    • 使用简单的句子,句子不用改长于两行
    • 每个段落应该由3~4个句子组成,最多表达一个主要的思想,以便文档能够呼吸
    • 不要有太多的重复,避免新闻稿风格--这种风格就是通过不断重复思想以确保读者能够理解
    • 不要使用多种时态,大部分时候用现在时就足够了.
    • 如果还不是一个真正的好作家,就不要在文档中开玩笑.
  • 限制信息的范围:每次只介绍一个概念

  • 使用真实的代码示例:应该抛弃Foos,bars这些陈腐的用词.

    • 代码示例应该在实际的程序中直接可用
  • 保持简单,只要够用即可:写的不是一本书!

    • 可以运行的软件胜过面面俱到的文档--敏捷宣言
  • 使用模板:帮助读者养成习惯

转载于:https://www.cnblogs.com/o-v-o/p/10214151.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值