行文规范，文章百赞 | 得到推荐的六个要点

「本文已参与好文召集令活动，点击查看：后端、大前端双赛道投稿，2万元奖池等你挑战！」

读书须用意，一字值千金。

6月30日晚，听了美女编辑 @大茹 主讲的掘金写做直播课，结合着阅读官方小册，收获满满，将相关规范总结成了如下六个要点：

• 文章类型
• 读者定位
• 主题与边界
• 结构与衔接
• 论据充分
• 排版优雅

但愿本身每次发布文章前，都能按照规范清单，校订核对，提升质量，使其更清晰优美，更畅通地技术交流，给读者提供更好的阅读体验！

写做审查规范

欢迎评论区交流补充！

文章类型

属于传授知识、阐述经验、表达观点？

知识

文章属哪一个领域：前端，后端，该领域前沿在解决什么问题？最好是配图说明。

例如，“阐述ArrayList与LinkedList不一样”，搭配Java的集合类图，会显得脉络清晰，考虑全面，读者视野也更开阔。

经验

踩过坑 OR 秀智商？

踩坑的详细过程：项目从需求->开发->交付->维护，哪一个阶段出了问题？损失如何？如何避免，除了问题后续又是如何弥补的？

秀你的算法/方案/代码：解决了问题亦或避免了问题的发生？

如“混合支付如何保证付款、退款的一致性”，能够阐述未保证一致性状况下发生了什么问题？错误的订单后续又是如何处理避免损失的？

与离散的注意事项相比，一个完整的解决方案更有收藏价值！

观点

大众或某类人的观点是怎样的？

信息差？缺乏哪些关键信息，才获得如此的观点，片面/局限/错误，亦或缺乏角度/态度？

或在补充了文章的关键信息后，便可获得文中结论？

固然，也可根据其余信息，从另外的侧面佐证大众观点。

好比前些天的云原生大会，能够收集资料与实验，去试图证实“Quarkus在云原生领域比Springboot更有优点和发展前景”，也能够去反证“Spring在云原生领域也将一统江湖”。

读者定位

外行/初学者/学生/编程人员/架构师/项目经理/你的老板/你的同事？

针对你的读者群：

读者痛点

该文可辅助读者解决什么问题，带来何种效益？

(1) 填补容易遗漏/遗忘的知识点？

(2) 能升职加薪？进入大厂，迎娶白富美？

(3) 是能节省时间，提升效率的快捷工具？

(4) 总结/汇总性质，帮助读者理清领域问题？

(5) 给读者补充信息，表达不一样的观点/经验/维度？

(6) ...

文章主题与边界

讲什么，不讲什么

可否用一句话概述核心？且其与标题、开头与读者预期是否一致？

要作标题党

固然，并非起那种语不惊人死不休的（具体参考各手机浏览器小文章），而是让你们经过标题，清晰的给文章主题划定界限。

小册中讲，选题就是“定义问题”的过程，寻找你与读者之间的认知差异。换句话说，文章的全部内容都应围绕“选题”，聚焦题目，分清主次，切忌喧宾夺主，不能作罗丹的雕塑手【我问了一下周围的人，好多不知道“罗丹砍手”这一典故】。

对于其余略有相关的内容，能够经过“这里我额外说一下……”管理读者预期。【小册】

并列出了几种掘金文章选题：

• 技术细节型
• 干货型：如介绍开源软件。
• 翻译文章，如翻译英文的技术文章
• 实践总结型
• 行业看法，职业选择

注重开头

文章开头是否能看出全文主旨、解决的问题、你的观点？

好的开始是成功的一半。

在网络上找到一些文章开头写法，虽然不满是技术文章相关，但但愿对本身，对读者有所启发：

• 开门见山
• 提示中心
• 描写引入
• 设置悬念（反问、设问、疑问）
• 对比
• 故事导入
• 名人名句引入
• 背景介绍
• 倒叙
• 形象比喻式开头
• 抒发感情式开头
• 交代缘由式开头
• 梦幻幻想式开头
• 心语诉说式开头
• 与读者交谈式开头

结构与衔接

结构

文章结构是横向平铺、纵向递进、总分、总分总？

• 是否有清晰的层次？
• 侧重点是什么？
• 是如何从总体到局部，从局部到细节推动的？

最好的技术文章当属论文。通常说来，论文的结构框架大体分为：文摘、引言、正文、结论、参考文献。能够给技术文章一些启发。

衔接

包括逻辑的衔接，语感的衔接。

逻辑的衔接，即A是否能推导出B？或每一个段落的行文理由、主旨关联是怎样的？

例如，“想要理解XXX，需先了解其是如何发展至今的？”，就给出了为何要阐述事物的发展历史与背景。

语感的衔接，即与大多数人的阅读习惯是否一致。最基本的句子“口感”通顺吗？长句子是否很容易理解？大多数人看好文章看不出来，可是坏文章很容易感受出来。

短句比长句好

论据充分

百字不如一图。说中国发展最好的证据即是GDP曲线图。说股票涨跌起起伏伏也不如贴一张价格曲线图。

论据包括：真实的数据（图、表），案例？，也能够是实验的关键代码及其执行结果？

表：实验结果/参考数据

图：框架图、路线图、思惟导图、设计图、流程图、调用图、时序图、实验截图/gif？

排版优雅

排版见仁见智吧！最基础的目录清晰，易于查找，符合逻辑吧。

好比下面的两种排版：

有人喜欢简约，有人喜欢动画。

如下是小册中概述的文章注意事项原文：

有没有明确交代要讲什么问题的开头；

小标题间符不符合纵向或横向的关系；

内容是否是先总体再具体；

文章结构是否能够抽象和拓展。

总结

内容具体，论据辅助，逻辑恰当，语句通顺

写做服务他人，启发本身。写做的惟一技巧就是“一直写”，高中最喜欢的一句英文：

Practice Makes Perfect

最后，祝你们

文章天成，妙手常得。

欢迎点赞评论！