如何写好一篇技术文章?
文章整理自:
掘金YoungZ 、Github ruanyf、知乎 敖天羽
很多开发者都喜欢在各类社区平台分享一些写作内容,一方面可以对人生的一些经历进行记录,同时将开发中的经验总结分享给其他人。当然写作本身益处也是不少的,不仅能锻炼逻辑思维能力,还能训练日益退化的语言表达能力,个人影响力上也能够达到一定的传播积累。
但更多的开发者会问,文章到底怎么写?什么的样的文章可以得到别人的认可与喜爱?
在写一篇文章之前,先想清楚以下几个问题:
这篇文章是写给谁看的?
这篇文章主要讲些什么?
文章具体怎么写?
给谁看
首先分析文章会给谁看,有了目标用户,你才知道需要产出一篇怎么样的文章。
比如,你的目标是小白用户,他们可能连 Node.js 都没有安装过,你上来就让他们配个 webpack 以达到什么目的,这多半是没什么指望了,你就得先告诉他们如何去安装 Node.js。
但如果你的文章面向的是更深层次的探讨和分析,为了这部分小白用户去增加篇幅大可不必,只会让那些中高级程序员觉得这篇文章废话连篇,原本的价值大打折扣。
实际上,一篇文章不可能面面俱到,所谓《从入门到精通系列》,即使是书,都是为了照顾新入门的准开发者们从零基础开始的,涵盖不了精通所需的很多东西。
写什么
文章内容的范围不宜过大,写大而全的东西对作者的水平要求非常高且需要消耗大量精力。如果真想写,也请先把思路理清,与有经验的人交流之后再下笔。
挑选的写作内容多是自己摸透了的东西,但是在细节上可能有模糊不清的地方。注意,你模糊不清的地方也正是许多人看此文的动机,务必查阅文献将此处叙述清楚!但又不可沉溺于细节之中,以能讲明白上下文为宜(更深入的细节适合另起一文)。另外,类似选型、对比、趋势一类的文章,对行业整体的把握也非常重要,在表达自己的观点之前,应该充分了解其它人的看法,尤其是和自己观点相左的看法。
一个小技巧是:在写文章之前,先把自己想写的主题用搜索引擎中搜一下,考虑自己是否有信心有能力超过已有文章。如果没有相关文章,那么可以先写入门级的内容,根据社区反馈逐步深入。
怎么写
技术文章的一大特点是文章逻辑严密,层级分明。因此在写作之前,应先列好提纲,根据内容层级由浅入深。
大部分技术知识可以用代码讲清楚,那么此处务必贴出代码。代码应该结构清晰,逻辑简单,能讲清楚问题就好了。一些关键代码需要有清晰的注释。如果有 demo,可以放上 demo 的链接。
在对高深内容或者细节进行描述时,即使前文已对相关名词做出了解释,也不应该堆砌专有名词。尽量用白话或者类比的形式将问题解释清楚,文字叙述不清楚的地方,请作图。
版面规范补充
字间距:全角中文字符与半角英文字符之间,应有一个半角空格。
错误:本文介绍如何快速启动Windows系统。
正确:本文介绍如何快速启动 Windows 系统。
全角中文字符与半角阿拉伯数字之间,有没有半角空格都可,但必须保证风格统一,不能两种风格混杂。
正确:2011年5月15日,我订购了5台笔记本电脑与10台平板电脑。
正确:2011 年 5 月 15 日,我订购了 5 台笔记本电脑与 10 台平板电脑。
半角的百分号,视同阿拉伯数字。
英文单位若不翻译,单位前的阿拉伯数字与单位间不留空格。
错误:一部容量为 16 GB 的智能手机
正确:一部容量为 16GB 的智能手机
半角英文字符和半角阿拉伯数字,与全角标点符号之间不留空格。
错误:他的电脑是 MacBook Air 。
正确:他的电脑是 MacBook Air。
文章句子,不包含任何标点符号的单个句子,或者以逗号分隔的句子构件,长度尽量保持在 20 个字以内;20~29 个字的句子,可以接受;30~39 个字的句子,语义必须明确,才能接受;多于 40 个字的句子,在任何情况下都不能接受。
避免使用长句。句子内部不使用逗号时,总长度不应该超过 40 个字;使用逗号时,总长度不应该超过 100 字或者正文的 3 行。
尽量使用简单句和并列句,避免使用复合句。
表示中文时,英文省略号(…)应改为中文省略号(……)。
英文:5 minutes later…
中文:5 分钟过去了……
英文书名或电影名改用中文表达时,双引号应改为书名号。
英文:He published an article entitled "The Future of the Aviation".
中文:他发表了一篇名为《航空业的未来》的文章。
总的来说,一篇优秀的技术文需要有:
• 取好标题,醒目突出中心
• 图文并茂,适当配图说明
• 篇幅适宜,不宜过短也避免冗长
• 格式统一,基本排版规则需要遵守
• 细节处理,错别字标点处理正确
LeanCloud正在发起线上征文活动,详情请点击活动海报 ↓ ↓ ↓
end
LeanCloud,领先的 BaaS 提供商,为移动开发提供强有力的后端支持。更多内容请关注「 LeanCloud 通讯」
如何写好一篇技术文章?相关推荐
- 程序员如何写好一篇技术文章?
本文字数:3536字 预计阅读时间:6分钟 背景 最近团队有同学提议,想探讨如何才能写出一篇优秀的技术文章.所以尽管水平实在有限,还是按照自己的经验和理解写下了这篇文章,亚历山大之余,也很高兴和大家分 ...
- 如何写好一篇技术文章
技术文章是能够有效锻炼表达能力和进行技术积累的方法.与单纯的技术笔记不同,我认为的技术文章应该是对实际的问题或新技术思路的解决方案,而不是技术点的简单堆砌. 对于如何写一篇我认为合格的技术文章, 最近 ...
- 我写的几篇技术文章之一:Windows消息拦截技术的应用
Windows消息拦截技术的应用<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office&quo ...
- 国内第一创作平台大佬,教你如何写好一篇技术博客?
码个蛋(codeegg) 第 975 次推文 作者:九心 链接:https://juejin.im/post/5ec29c16e51d454d9b12677f 前言 很多同学的进阶都是从写文章开始的, ...
- 2021年1-9月墨天轮最受欢迎的20篇技术文章
自墨天轮社区成立以来,众多的的数据库相关从业者们在此相聚,大家技术专业.热爱分享.乐于交流,将自己日常的工作经验.技术雷区.学习笔记分享于此. 这些来自数据库系统架构.中间件.性能优化.交付等等不同岗 ...
- 如何写好一篇技术论文
科技论文的写作质量是决定论文能否被录取的关键因素之一,再酷炫的算法如果写不好也难逃被拒的命运.因此,如何能写出好论文也成为了研究人员必须学习并掌握的一门"技术". 这次分享主要介绍 ...
- SAP成都研究院2018年总共87篇技术文章合集
2018年很快就要结束了.Jerry在2017年年底准备开始写这个公众号时,给自己定的目标是:2018年至少保证每周发布一篇高质量的文章.如今2018年就快过去了,高质量与否需要大家来反馈,至少从量上 ...
- 2020年美团技术团队最受欢迎的16篇技术文章
2020年,对所有人来说,都是一个非常特别的年份.年初新冠肆虐,让我们焦虑.茫然.但我们举国协力,一起走过了阴霾和风雨.这一年,我们收获了无数的感动,特别感谢26万读者的一路相伴. 今天是2020年最 ...
- 2021年美团技术团队最受欢迎的22篇技术文章
再见2021 你好2022 「美团技术团队」微信公众号祝大家新年快乐!温故而知新,我们根据文章的「阅读量」和「在看」数,以及所覆盖的技术领域,精选了22篇技术文章作为新年礼物送给大家.希望在2022年 ...
- 写好一篇技术博客的正确姿势是什么
写好一篇技术博客的正确姿势是什么 今天写博客的时候,发现不知道怎么构思,怎么布局了.然后就想到了以下这些问题: 怎么写出来对别人更有价值的文章,同时也更方便自己下次阅读,方便读者阅读? 为什么别人写的 ...
最新文章
- 揭秘天猫双十一背后的那位贤内助
- LINUX 操作记录到syslog,并发送到syslog服务器上
- android开发中的 Activity 与 Context 区别与联系
- Python之web开发(六):python使用django框架搭建网站之图表显示操作
- hdu 1723(简单dp)
- 解决deepin下挂载的的Windows系统(NTFC)目录是只读的问题
- 又一款超酷的 Python 可视化神器:cutecharts
- phpvirtualbox+Virtualbox完整虚拟化环境部署
- threejs骨架形状
- 【转】ABP源码分析八:Logger集成
- 从java进程里dump出类的class文件的小工具--dumpclass
- (Life)质量和服务_由购买联想笔记本想到的
- 香港理工大学ASSIST2011会议(2011-09-30)
- 各省能源平衡表(2000-2018年)
- cnpack导致view快捷键失灵。
- 无线WIFI短信认证平台(互亿无线)
- python调用nmap扫描局域网存活主机和端口
- 团队开发过程中的一点感想
- 判断魔方阵c语言程序设计_魔方阵原理及十种解法(C语言)
- 2022华为机试社招OD高频考试真题【9, 10月份Q2, Q3考试新编程题目】