撰写准确的文档
想要让文档准确,要做到以下几点:
- 先理解你要写的东西,然后再动笔,最后再验证你写的东西。不能不懂装懂,泛泛地写,甚至提供错误信息。
- 跟上技术的变化。每个版本的产品都会在某些方面升级改造,文档定稿前要仔细检查各种版本、商标、产品名是不是与实际相符合。
- 保持信息的一致。同一件事,不可以在这里是这么说的,在那里就变成了那么说的。可以通过重用的方式让信息保持一致,或者删除没有必要的重复信息。
- 使用工具检查文档的拼写和语法等。
- 检查参考资料的准确性。有的适合,你引用的某个网址有可能在某一天失效,或者你有可能插入了错误的链接,所以文档定稿前要逐一检查这些链接,确保它们都能显示且显示的内容是想要的内容。