技术写作的自我分析

By | 2018年8月3日

任何事情,都有其解决方法与套路,写作也不例外。

作为开发者,经常碰到自己知识范围之外的问题,通过搜索引擎找到解决方案也是日常工作一部分。搜索出来的结果自然也是千差万别,大致可以分为 笔记型、翻译文档型、教科书式型、深度剖析型和照搬转载型这五大类型。

只列出问题和解决方案,但并不对其方法进行解释和剖析的笔记型最为常见,这可能也是大多数人最愿意采取的方式。简单方便,将解决的问题做一个简单的记录方便下次快速查找,又不需要花费太多时间,对于提高经验和提高开发速度确实有很多益处,但也有很多局限性和不足。首先,大部分人并不走心,找到解决方案改好就行,不会去深究其原因,知其然不知其所以然。其次,技术进步迭代速度很快,随着时间的推移,很多解决方案也就有更好的解决方法或者之前的方案完全被抛弃,需要重新更新方案。

只有问题答案的笔记型充其量只是一个笔记,算不上技术写作范畴,以前看到有些博客都是这种形式,自己也这么写过一段时间。但感觉这种并没有太大意义,不如讲这种记录在云笔记本上更为合适。

文档翻译或许是写技术文章最简单的入门方式,在翻译过程中既需要理解透彻文章所写内容,又能学习到别人的写作架构和风格。但需要对英文能力有较高的要求,自己学习英语也是断断续续,时而坚持一段时间,时而彻底抛之脑后,再读起英文文章也是挺吃力的感觉,尤其技术文档,如果英文不好读起来既枯燥又费力,坚持一会儿就很难坚持下去了。从这点上来看英语学习真的需要当做一个长期坚持的事情,可以切切实实的让自己学到很多东西。

教科书式的方式写作是我最不喜欢的一种,除非要写本书,或者出一个系列的讲解。因为这样写出来的内容其实大部分教程或者网上都有,说是教程但是没有直接参考专门的简易教程来的方便,说是笔记也突出不了笔记应有的重点,如果不照办现有的知识自己也不可能创造出这么多知识,照搬的话失去应有的意义。实在是尴尬的很,索性不用这种方式。

针对某个主题进行深度的剖析和详解,这种技术文章是我最欣赏和敬佩的。要写出这种文章,需要对描述的主题有很深的认识和了解。之前总以为水平到一定程度就可以很容易写出这些有深度的文章来,后来发现文章都不是随随便便就可以写出来的,都是经过对每个细节的仔细深究,对各种参考资料的仔细总结,并且加上自己的理解最后才能写出来的。技术写作也是有很多方法和套路的,更有很多技巧可以来借鉴的。

就像听朋友说,经常给领导写讲话搞也是有固定的模板和提前准备各种素材的,遇到各种类型的就用对应的模板去套着写就可以了。技术文章虽有很多不同但也有很多可以借鉴,都是有其方法,也就是说可以学习和练习好的。

最难的事情,还是贵在心平气和的坚持做下去,在枯燥中找到其乐趣所在。

发表评论

电子邮件地址不会被公开。 必填项已用*标注

This site uses Akismet to reduce spam. Learn how your comment data is processed.