接下来,小编将分四个方面大概说下:
一、一篇技术文章要考虑的7个方面
二、如何设计文章结构
三、修辞润色
四、常用的技术文章选题(此文仅针对运维工程师)
一、技术文章要考虑的7个方面
以技术文章为例,需要考虑如下7个方面:
1、价值:文章能给读者带来什么价值?站在读者的角度读完这篇文章,应该得到什么,这是最先要考虑的。
2、受众:定位阅读对象是谁?给小白还是给资深技术人员,不确定受众,就没办法有针对性的写作。
3、选题:文章写什么?通常来讲,单篇文章,选择比较小的一个点来讲明白,比较好。以安装类技术文章为例,从安装原理--安装包下载--安装操作步骤--注意事项等,完整的介绍清楚,不管有无基础,看了一定会安装;(不知道如何找选题?请参照文章下方第四大点)
4、示例:给出参考图片,配置的具体截图等
5、背景介绍:说明所选知识点可以解决什么问题,以及它的应用场景
6、注意事项:例如使用产品的常见问题及误区
7、关联参考资料:如果借鉴了其他资料,需要说明你引用了什么,拓展阅读,关联主题等
这部分考虑的是文章的原始素材,相当于积木块,是写文章的基础。
二、如何设计文章结构
考虑了前面的7个方面,接下来就是如何把文章写出来?这方面必须要遵循一定的结构,没有结构,就没有文章。而且,有了好的结构,不但能让读者易于理解你要传递的内容,还能使你的文章保持一个基线水准,不至于看起来太糟糕。
那文章结构究竟如何搭建呢?具体又有哪些结构?
举个简单的例子:常见的QA(问题-答案)式结构,先说问题,再给建议(N条并列)。同时在给建议时,还可以给出了正反测验对比,让人一对比就能体会到差别,Get到您想要传递的东西。
一篇技术文章,除了以上说的这种结构体,还有开篇、总结、呼吁行动等环节。综合起来,常见的技术文章组织结构如下:
开篇:这部分阐明文章讲什么、能带给读者什么价值;
结构体:按照一定的结构,展开叙述,常用的结构有以下几种
a、比如QA(问题-答案)结构:先说问题,再给建议或者解决方案,可以多条并列。
以故障排错为例:问题现象--原因分析---排查思路和解决方法--排查结果--注意事项” 可以参考这样的组织结构写作;
b、比如实战小项目的讲解过程(项目背景-效果展示-设计解释-方案演示-方案解读-延伸场景)等;
c、比如设计演示示例的过程(问题-设计思路-演示解读-结果展示)
d、比如并列条目(系列问题说明),其他还有很多,例如按总分总、时间线陈述的结构
总结(注意事项):一段话,简单回顾讲过的要点,指出读者应该注意的地方
我们写文章,可以设计几种常见的文章结构,反复使用,操练纯熟之后,写文章就会很快,直接整理素材,然后填空就好了。这也是为什么很多人能够持续产出内容的一种原因——把重复性的东西模板化,减少时间和精力占用。
三、修辞润色
修辞包括:语言、文法和修辞手法。技术文章而言,修辞可以增加文章可读性并不是重点,这方面的提升,不是一夕之功,而是长时间积累的结果。必须先写,写起来多读几遍就行优化润色即可。
以个人经验,提升这方便能力比较重要的是:阅读文艺类书籍。熟读唐诗三百首,不会写诗也会偷啊!
四、常用6种文章选题(仅就运维工程师而言)
项目经验类:
选题:分享一个亲身实践的项目实战案例
结构:项目背景---效果展示----设计解释---方案演示和解读---延伸场景--总结与建议
测试实施类
选题:客户测试需求--制定具体的实施方案
结构:测试准备环境(条件)-----部署拓扑(附图)及拓扑说明------配置方法说明及配置的注意事项----实施效果图
安装部署类
选题:部署了一个新设备经验分享
结构:前提条件---安装原理---安装包下载路径----安装操作步骤-(截图)--- 完成效果----注意事项等
产品使用体验类
选题:某一个新产品或者新功能的使用分享
结构:功能介绍:新产品或新功能的使用价值和使用场景(附拓扑图)-----使用后能解决什么问题-----具体的配置步骤(附截图)----使用效果(有截图)-----使用注意事项。
故障案例类
选题:反馈出某一个典型故障问题
结构:问题描述---告警信息(截图)---处理过程----根因----解决方案----总结与建议
安全事件类
选题:解决一个安全漏洞事件分享
结构:背景介绍---漏洞描述---影响范围---修复建议---解决方案----总结与建议--注意事项等
其他注意事项:
1、隐私保护,请注意打码处理
2、请注意隐藏用户信息,同时不要将设备密码、使用IP等直接贴出来
写在最后
大家在写作之前,可以先从以上7个方面思考和准备,然后按照自己建立起来的文章结构模板来快速整合素材呈现为文章,再加上一点点语言和修辞,你就可以写出不错的技术文章啦。
好了,以上就是本次教程分享的全部内容了,接下来,就要看你的了。强烈建议你选择一个知识点——比如某个故障问题,复制前面提到的某一种结构体,写两篇文章来练练手。等写熟练了,自己再改结构、定义自己的文章结构。
文章部分资料来源:慕课网
实际行动是最好的老师!