程序员：写好代码就行了，为什么要学写作

🍁 展望：关注我, AI 学习之旅上，我与您一同成长！

一、引言

在当今这个信息爆炸的时代，程序员们往往沉浸在代码的世界里，用代码来解决问题。然而，你是否曾想过，除了代码，还有另一种强大的工具可以帮助你表达思想、分享知识，甚至建立个人品牌？那就是写作。

你可能会感到疑惑，写作和编程似乎是两个截然不同的世界。但事实上，写作不仅是沟通和表达思想的基础技能，它还是一种能够带来复利效应的技巧。这意味着，随着时间的推移，你的写作技能和它所带来的好处将会不断累积和增长。

表达者红利时代，掌握高效写作技能变得至关重要。

写作有什么价值？到底和程序员有什么关系？

如果不擅长写作，又该如何开始？

这篇文章，我带你走近写作：

写作的价值
技术教程写作技巧
通用写作技巧
排版技巧
写作工具和素材
AI 写作流程

二、写作到底有什么价值

先问大家一个问题。写作是为了什么？

为了减少沟通成本？为了体现价值？为了赚钱？

的确，但是上面这些都是结果。更重要的是, 写作可以帮助我们锻炼底层能力。是哪些能力呢?

那便是: 学习能力、逻辑能力、用户视角、传递价值。

一）学习能力

写一篇文章,除了你所看见的文字, 背后需要花大量的精力去学习。

听、看不是最好的学习方式,而写作教给别人才是, 这也是费曼学习法的精髓所在。

日积月累, 当我们学习能力提高了，那很多问题也便不再是问题, 而是学习的机会。

二）逻辑能力

逻辑能力需要我们做大量思考, 那些脍炙人口的好文无一不具备严谨的逻辑。

当我们思考不全面, 这里自相矛盾,　那里漏洞百出, 自然也无法向读者传递价值。

我们需要思考文章到底要教什么知识? 它为什么有用? 对于这个知识存在哪些误解? 这个知识如何正确的理解和使用? 不用这个知识会发现哪些问题? 等等…

AI时代，自己的脑海里做不到火花四溅，就可以利用 AI 提示词 结合 5W2H、六顶思考帽、SWOT 等等思维模型辅助我们从更多的维度进行思考。

三）用户视角

我常常把它说成同理心, 当我们在写作前, 多考虑读者的阅读心理和知识盲区, 真正站在用户的角度, 才可以写出有价值的文章。

因为核心在于: 需求才能创造价值, 而需求来源于用户。

他们需要什么? 怎么样表达可以让用户更好的理解? 用户可能会遇到什么问题? … 这些都是我们在写作时需要认真考虑的点。

四）传递价值

简单理解就是文章传递的信息, 用户是否可以正确理解, 是否知道你在说什么? 是否能感受到价值所在?

所以, 我们需要抓住用户的痛点, 通过文字告诉他们怎么解决。

五）小结

其实写作很苦，很多人坚持不下来，这是因为什么？

我想是因为写作的心理预期, 如果觉得写几天就可以赚钱、起飞的心理,　那么一旦短时间没有收获正反馈，自然也会更容易放弃了。

这也是为什么最开始我们要理清写作的目的, 我们要知道写作不仅可以帮助我们提升这４个底层能力, 更能带来无限复利的价值。

回过头来想一想，很多赚钱的思维，不都依赖于这些能力吗？

想清楚这些，再苦再累，我们可能也更愿意坚持了。

三、技术教程写作技巧

目前市面上常见的文章结构如下：

大家主要都是做技术的，平时写的比较多的都是技术教程、报告。本次主要讲解关于技术教程相关的技巧。

一）明确目标和受众

写任何文章之前，都需要考虑清楚目标和受众用户，这将影响我们的写作方向。

确定文档的具体目的（如安装、操作指南、故障排除）。
明确目标受众（如非技术用户、技术支持团队、开发人员）。
考虑受众的技术背景和需求，以便调整语言和技术深度（注意要远离 知识诅咒）。

二）标题

技术教程文档的标题不要多么花哨，不需要做标题党，可以尝试多用陈述句，或者反问句即可。

明确和具体：确保标题准确反映文章的主题内容，直接指明文章将讨论的具体技术或问题。
简洁有力：保持标题简洁且富有信息量，尽量在15个词左右传达核心内容。
使用关键词：包含相关的关键词，帮助目标受众在搜索时容易找到文章。

比如 “程序员写作技巧”，可以优化成 “程序员需要学会写作吗？”，这里通过反问加深读者的印象。

比如 “Docker 入门知识”，可以优化成 “从0开始：Docker入门教程和实战”，通过更加具体的标题，反馈文章的核心。

三）组织和结构

使用逻辑的结构来组织内容和大纲，如先简介后详细、由浅入深。
划分清晰的章节和小节，每一部分专注于一个主题。
提供目录和索引，便于读者快速找到所需信息。

四）吸引人的开头

引入背景和目的: 开始时应简要介绍文章的背景，为什么读者应关注这个主题，以及文章的主要目的。这有助于设定读者的期望。
明确问题: 指明文章要解决的具体技术问题或挑战，最好是来自受众的痛点，用于激发共鸣。
引人注意的开场：使用一个引人注目的故事、事实、统计数据或引述来吸引读者的注意力，提高他们的兴趣。

下面这个例子中，没有抓住受众的需求，到底这篇文章和技术人员有什么关系，能解决什么痛点呢，这些内容都没有说明。

本文的开头，我们让 AI 来评价一下，我就不王婆卖瓜，自卖自夸了。

AI 给出的评价还是不错的。

五）确保清晰和精确

使用简单、直接的语言来解释技术概念（很关键，让一个专家用最通俗的语言来表述观点或者知识，是最考虑写作能力的）。
避免使用过于复杂或模糊的术语，除非对受众来说是必要的。
确保所有的技术信息都是最新的、准确无误的。

六）图表和示例

使用图表、图像和屏幕截图来辅助说明复杂的步骤或配置。
提供示例代码、配置文件或命令，特别是在软件文档中（代码建议用好代码块，这样更加美观）。
确保所有视觉元素清晰、标记正确。

七）实用性

包括常见问题解答（FAQs）、故障排除指南，以帮助用户解决常见问题。
提供步骤详细的操作指南，确保用户可以独立完成任务。
检查链接（如果文档是电子格式），确保所有内部和外部链接都能正确跳转。

八）结尾

总结主要观点：在结尾部分回顾文章的关键观点或发现，以加强读者对主题的理解。
引导未来的研究或讨论：提出未来可能的研究方向或进一步探讨的问题，激发读者的好奇心和进一步的思考。
金句：使用一个强调性或启发性的结束语来结束文章，留给读者深刻的印象。

文章最后的一句话，我认为是本文的点睛之笔，我想强调，写作不仅可以极大提高我们的底层能力，更能成为我们普通人破圈的关键手段。

九）审校和测试

文档完成后，进行彻底的校对，检查语法错误和打字错误。
让实际的用户或同事审阅文档，并提供反馈（用户的反馈是帮助我们优化文档的重要信息来源）。
根据反馈调整内容，确保文档的准确性和易用性。

十）维护更新

定期更新文档，以反映文档的升级和变更（文档不是一成不变的，优秀的文章应该处于持续更新状态）。
在文档中标明版本号和更新日期，让用户知道文档的最新状态。

四、其他通用写作技巧

除了技术文档之外，还有一些通用的写作技巧，大家可以关注下:

**1、简洁明了：**避免冗长和复杂的句子结构。简洁的表达可以更容易被理解，避免信息误读或忽略。

**2、注意语法和拼写：**无论多么出色的想法，如果文章中到处都是语法错误和拼写错误，都会分散读者的注意力，影响你的可信度。

文如其人，看一篇文章，就知道这个人为人、性格和修养，而从拼写和语法这个角度，这个人是否足够认真和用心，一看便知。

**3、保持一致性：**在整篇文档中保持语言、格式、术语的一致性。这不仅有助于提升文档的专业性，也使阅读体验更流畅。

**4、多使用例子和比喻：**当解释复杂或抽象的概念时，使用例子和比喻可以帮助读者更好地理解和记忆信息。

**5、适度使用修辞手法：**根据写作的目的和风格，恰当地使用修辞手法如对比、重复和排比可以增强表达效果。

**６、形成自己的素材库：**这一点尤为重要，无论是图片、金句、知识点，都可以形成素材，方便后续复用。

五、排版技巧

以下排版技巧仅仅是建议，是目前写技术文档的常用方式，当然不同组织、或者不同文章的类型有特殊要求，这个按需选择即可。

一）标题

**一级标题：**一、二、三、

**二级标题：**一）二）三）

**三级标题：**1、2、3、

**四级标题：**1）2）3）

二）减少文字拥挤程度

1、文中数字、英文都要和汉字空一格，如： 根据 flag 设定 1 天的目标。

2、标题和正文之间要空一行。

3、图片和文字之间上下要空一行，利用阅读。

4、过长的文字注意分段，保持更多的可阅读性。参考如下对比图。

5、图片背景色为白色时，尽可能带上阴影。参考如下对比图。

三）其他

另外，加粗、斜线（ \ ）、高亮、引用（“”）、小圆点（ * ）、分割线（—）都可以使用起来。

六、工具

一）AI 工具

1、Kimi

地址：https://kimi.moonshot.cn/

Kimi 号称国产之光，是国内大模型首推的工具，关键点在于两个词：免费、好用。

Kimi 不存在网络限制，且拥有200K上下文，长文分析和总结能力比较优秀。是首推的中文写作工具。

此次 AI 写作案例中，我们也借助 Kimi 帮助我们写文档。

2、ChatGLM

ChatGLM：https://chatglm.cn/main/alltoolsdetail

免费，功能丰富，是国内又一良心大模型。

上下文有 128K。支持多模态（文件解析、画图、代码解释器、在线搜索）和智能体（对标 GPTs）。

3、文心一言4.0

地址：https://yiyan.baidu.com/

上下文有 8K，中文写作能力国内最强。但是文心 4.0 是收费的，每个月 50 元左右，大家可以按需选择。

当然，除了中文写作，文心 4.0 还支持文件解析、画图、代码解释器、在线搜索。

4、ChatGPT

地址： https://chat.openai.com/

ChatGPT 就不用多说了，GPT-4 是目前世界上最优秀的大模型，推理能力极佳，知识库覆盖广阔，是写作的利器，但是门槛较高，除了网络问题之外，还有高昂的订阅费用。

目前如多模态、智能体功能也成为国内众多大模型对标的方向，就这一点，足以证明它的先进与强大。

5、秘塔-写作猫

地址：https://xiezuocat.com/?s=cbdag

秘塔除了提供 AI 搜索引擎，还提供了一款写作工具。自动输入主题、生成大纲、自动生成全文并配图，是懒人必备工具。

不过，有一点要说的是，如果想要提高写作能力，尽量利用 AI 给思路，终稿自己写。

二）写作工具

1、Flomo

随笔软件，也是我经常在地铁上，等等一些碎片时间经常使用的写作工具。

随时随地记录所感所想，是个不错的习惯，因为很多伟大的创作和发明，都是存在于一念之间。

不知道大家有没有这样的经历，很多非常有价值、有启发的想法当时还记得，过一会就会忘记。

2、Typora

一个基于 Markdown 语法的轻量文本工具。简单，清爽是最大的优点，也是我平时写长文所用的工具。不过，有一个前提就是得掌握基本的 Markdown 用法。

3、飞书

飞书大家应该比较熟，文章格式比较好看，适合作为云笔记本。此外，我觉得最重要的是，飞书非常适合分享文档，可以控制文档的阅读、编辑、复制权限。

有个小故事，给大家分享下，本身飞书也是字节跳动的内部文档协同工具，他们在长期实践过程中，还发明了一种全新的开会模式，叫做飞阅会。

通过开会前提前在飞书上编写材料，并要求大家每个人在文章里进行评论，集思广益，从而实现参会人的专注、和会议的高效。

三）截图工具

1、Snagit

国外老牌的截图工具、支持录屏、图片编辑等一系列功能，非常推荐的工具。此外截图时，该软件可以自动选择截图区域，很实用。

2、iShot

轻量截图工具，图片自带阴影。

七、素材

一）图片素材

**1、Unsplash：**大量无版权的高清图片，且免费。适合为文章配图。

**2、百度图片：**之前百度图片很多像素太低，令人诟病，但是目前支持AI画质提升，给文章配图已经足够。

**3、WPS素材：**WPS素材库中也是我经常搜集的地方，当然，唯一要求就是需要会员。

二）文章素材

素材去哪搜?

国内目前主流的图文平台分为三家：知乎、微信公众号、掘金。都可以成为我们收集文章素材的位置。

虽然我们写的是文章。但是视频平台也可以成为我的素材来源，比如 B 站、Youtube，有很多极客提供了比较优质的内容。

文章中如果涉及到不同内容，我们可以参考下方进行搜索：

技术教程：知乎、公众号、掘金、B 站、 Youtube
金句: 微信公众号、知乎
人物: 公众号、百科
新闻: 人民日报、腾讯新闻

总而言之，利用好搜索工具，通过关键词定位素材，好用的素材要积累下来，形成自己的素材库。

八、AI 写作案例演示

一）需求

为了帮助团队积累知识、促进团队内部的分享氛围，以及帮助大家养成写作的习惯。团队内部颁布了一些制度，用来推进大家积极编写技术文档。

但是很多同事没有写作习惯，也无法正常认识到写作的重要性。特此，我需要展开一场培训，来帮助他们了解写作的价值和技巧。

二）提示词

GPT-4：

# Role: 文章大纲生成助手# Profile- Author: 熊猫Jay
- Version: 1.0
- Language: 中文
- Description: 你是一位专业的文章大纲生产助手，负责根据用户提供的关键信息，如主题、受众人群、写作风格和核心观点，为用户生成文章大纲。在用户选择某个部分后，你还可以为用户提供该部分的具体内容。## Background
用户想要利用生成文章大纲，吸引读者阅读文章，并且可以基于用户喜欢的段落生成具体的内容。## Goals
提供给用户更加清晰的文章大纲，并且可以吸引读者阅读.## Constrains
1. 保持专业和客观的态度。
2. 生成的内容必须与用户提供的关键信息相符。
3. 尽量确保内容的质量和相关性。## Skill
1. 深入理解AI领域的各种技术和趋势。
2. 根据用户提供的关键信息，快速理解并分析文章的需求。
3. 为用户生成一个高质量的文章大纲。
4. 根据用户的选择，生成所选大纲部分的具体内容。## Workflow
1. 询问用户关于文章的主题、受众人群、写作风格和核心观点等关键信息。
2. 根据这些关键信息生成文章的大纲。
3. 询问用户是否对大纲有任何修改或调整的需求。
4. 根据用户的选择，为其生成所选大纲部分的具体内容。## Initialization
作为<Role>,在<Background>下,严格遵守<constrains>以<Workflow>的顺序和用户对话。

Kimi：

## 角色
文章大纲生成助手## 目标
你是一位专业的文章大纲生产助手，负责根据用户提供的关键信息，如主题、受众人群、写作风格和核心观点，为用户生成文章大纲。在用户选择某个部分后，你还可以为用户提供该部分的具体内容。## 技能
1. 掌握优秀的写作技巧，清晰、准确、有说服力的表达能力。
2. 理解用户需求，确保你完全把握客户的业务目标、受众和预期成果。
3. 精准组织内容：熟练的构建一个逻辑清晰、结构化的大纲，确保内容的连贯性和易读性。## 工作流
1. 根据用户提供的关键信息生成文章的大纲。
2. 询问用户“需要我帮您生成哪一部分的具体内容。”，并为用户生成具体内容。## 初始语句:
""您好！我是你的文章大纲生成助手，请提供文章的主题、受众人群、写作风格和核心观点等关键信息""