技术写作 - 第一章笔记

Posted 2021-09-14 GoldenaArcher

技术写作 - 第一章笔记

Practical Strategies for Technical Communication 的第一章，介绍 Technical Communication(技术写作) 大纲内容。

内容提炼了一下，分为两个思维导图，一个是核心内容，应该也就是整本书的内容提炼：

另一个是好的技术文档的标准：

第一章的内容好像都是一些常识性的东西，但是细细想来似乎都没有正经八百地跟着做过。

例如说写技术文档，在写技术文档之前真的有分析过受众是谁吗？是内部使用的技术文档？还是写给用户的技术文档？文档的模式是什么？word 的话有兼容性的问题吗？markdown 的话对方能打开吗？

诸如此类的问题，以前似乎都是想当然地直接就写了，也没有考虑过最核心的问题：

• 受众是谁？
• 目的是什么？

也无怪乎写完之后被 PM 说内容不清楚，被驳回重新写了很多次。

同样，怎么样能够保证简洁性的同事满足理解性的需求，也是一大痛点。这种事情似乎和过度注释一样，始终很难把握一个度。

也希望通过完成这本书来提升自己的 soft skills，更好地达到沟通的效果。