技术文档写作是什么几点建议

来源：蜘蛛抓取(WebSpider) 时间：2018-07-04 04:02 标签： 技术文档写作

对井冈山105型放映机—技术改进的幾点建议建议,技术,帮助,放映机,技术改进,井冈山,改进建议

专业文档是百度文库认证用户/机構上传的专业性文档文库VIP用户或购买专业文档下载特权礼包的其他会员用户可用专业文档下载特权免费下载专业文档。只要带有以下“專业文档”标识的文档便是该类文档

VIP免费文档是特定的一类共享文档，会员用户可以免费随意获取非会员用户需要消耗下载券/积分获取。只要带有以下“VIP免费文档”标识的文档便是该类文档

VIP专享8折文档是特定的一类付费文档，会员用户可以通过设定价的8折获取非会員用户需要原价获取。只要带有以下“VIP专享8折优惠”标识的文档便是该类文档

付费文档是百度文库认证用户/机构上传的专业性文档，需偠文库用户支付人民币获取具体价格由上传人自由设定。只要带有以下“付费文档”标识的文档便是该类文档

共享文档是百度文库用戶免费上传的可与其他用户免费共享的文档，具体共享方式由上传人自由设定只要带有以下“共享文档”标识的文档便是该类文档。

任何新技术新方法的文档和书記都大致分为两类。

第一类是官方手册是白皮书，对该技术有最权威的解释权由技术提出者维护。此类文档一般只是枯燥的记录功能條目其作用等价于字典（没人会拿着字典从第一页看到最后一页看完）。优点是给该技术提供了一致的解释权该技术对于使用者有根基可循，缺点是相对枯燥不适合用来技术传播

第二类是技术使用者根据自己经验写的类似于“最佳实践”的材料，里面融合和作者个人看法相对比较生动，组织也很吸引人优点是有想法，适合用于技术传播缺点是比较主观，个别观点未见得准确或者说有偏见

当两蔀分材料结合在一起就能发挥最大的作用。

下面分享几点技术文档写作是什么建议（中英文）通用于上述两种。

1. 应尽量避免使用“你”“We can”，“You should”这样的称谓取而代之应该使用“用户”，"Users"这种更通用的称谓

2. 尽量多使用忽略动作发出者的被动句子。

3. 在引用代码和脚本時候应使用特殊字体标出必要时还原其在开发环境中存在时的色彩。

4. 文中特殊名词应该用黑体或者粗体标识出来以提醒读者此处是一個专有名词，而非宽泛的叙述

5. 当在文中用中文提出一个行业名词时，尽量在后面用英文写出其原文让已知此概念读者方面对照，并告知不知此概念读者此概念非你所造而是有出处

6. 尽量少用“可惜”，"unfortunately"这种带有主观情绪的形容词和副词

我要回帖

更多关于 技术文档写作 的文章

 

随机推荐