01 2013 档案

摘要:任何新技术,新方法的文档和书记都大致分为两类。第一类是官方手册,是白皮书,对该技术有最权威的解释权,由技术提出者维护。此类文档一般只是枯燥的记录功能条目,其作用等价于字典(没人会拿着字典从第一页看到最后一页看完)。优点是给该技术提供了一致的解释权,该技术对于使用者有根基可循,缺点是相对枯燥不适合用来技术传播。第二类是技术使用者根据自己经验写的类似于“最佳实践”的材料,里面融合和作者个人看法,相对比较生动,组织也很吸引人。优点是有想法,适合用于技术传播,缺点是比较主观,个别观点未见得准确或者说有偏见。当两部分材料结合在一起就能发挥最大的作用。下面分享几点技术文档写作建议(中英文),通用于上述两种 阅读全文

posted @ 2013-01-10 17:28 绿里奇迹 阅读(403) 评论(0) 推荐(0) 编辑 |

Copyright © 2024 绿里奇迹
Powered by .NET 8.0 on Kubernetes