“需要写东西了,但没选题” “内容无法和业务做融合” “用词很苍白,没法精准表达” 在工作中,我们时常面临需要写作的场景,却总在落笔时卡壳。
技术文章具体该怎么写
提升技术文档写作的小妙招/小技巧
技术文章的写作之路
男朋友说:你刚买的洗面奶是生姜味的啊? 妹纸听了之后觉得:蠢男友居然连青柠和生姜都分不清楚; 又想起,男朋友不喜欢吃生姜; 又想起,自己对男朋友真好,做菜从来不放生姜; 又想起,但是男朋友根本不记得自己不爱吃青椒! 又想起,但是男朋友居然记得前女友不喜欢吃豆芽! 妹纸说:你自己一个人过吧! 男朋友:???
What:要讲的技术是什么
When+Where:这个技术是用在哪里、什么场景下使用
Why:为什么要用这种技术,好处是什么
Who:谁在使用这种技术
How:如果使用这种技术
内容没有体系,散文一样,没有目录结构,阅读心智负担极大,导致没有人看
没有目的性的文档,没有指导意义,例如只说明问题,没有提供解决方案,看了之后不仅不会豁然开朗,反而更困惑
有明确目的,比如技术文档,发布文档,接入文档,复盘文档
清晰明了,不啰嗦,文字详尽,配以图表、截图和示意图,方便阅读者理解
好的文章是一款面向傻瓜用户的好产品
分层,分目录,便于快速索引,让阅读文档的人可以快速找到可能需要的知识
主动性是做好一切的前提,写文章永远不是为别人,是提升自己的重要手段
大部分的文档的主要阅读者是你自己,未来的你查缺补漏
口口相传的知识并不能成为你的知识,好记性不如烂笔头,文档库就是你的知识库
聊天记录靠不住,要把关键会议和需求方案,技术方案对齐后落地到文档里
写文档就是倒逼你思考的过程,是一个锻炼独立思考的过程
明确写作目的后,你应该找到对应的模板,例如技术文档,发布文档,接入文档,复盘文档,比如在我们团队内部都会进行相关文档模板的建设,很容易就能获取文章写作架构
文章不是自上而下,瀑布式的写作,而是先有架构,再有摘要,最终填充内容细节和图,第一步的模板也能帮助你快速搭建架构
不要有负担,先用最僵硬直白没有心智负担的方式把要写的东西一股脑按结构写入,然后再反复阅读去润色表达
多模仿,无论是写技术文章还是专利交底书,还是散文,多看优秀的示例,对表达结构和顺序的优化都有很大的帮助
多写,写作是个正反馈系统,只要你写了就会有人点赞,点赞多了你也就更愿意写