用 Org 写技术文章

技术文章不只是代码片段。问题是什么，为什么这样做，结果如何验证，都值得一起记录。

这篇文章整理了几种常用的 Org 写法，作为这个站点的第一份写作笔记。

先写清楚问题

一篇实践记录可以从三个问题开始：

把环境、输入和预期结果写清楚，比单独贴一段代码更容易让读者复现。

Org 使用星号表示标题层级。一个星号是一层标题，两个星号是下一层。长文章按“背景、实现、验证”拆分，阅读和后续更新都会更方便。

* 问题背景
说明环境与目标。

* 实现过程
** 第一步
写下实际操作。

* 验证结果
记录输出与结论。

用源代码块保存示例，并注明语言。尽量选择最小的完整示例，避免省略关键的输入和依赖。

function greet(name) {
  return `你好，${name}！`;
}

console.log(greet('Org'));

行内的命令、变量和文件名可以用等号包起来。例如，使用 hugo server 命令在本地预览站点。

代码后面补上预期输出，再解释输出说明了什么。读者便能区分“运行成功”和“结果正确”。

你好，Org！

链接既能指向参考资料，也能指向站内的其他文章，例如 Org Mode 官方网站。

先把问题复现出来，再动手修改。验证方法应当和解决方法一起记录。

截图可以和文章放在同一个目录，通过相对路径引用。不要只贴图，最好同时解释截图中的关键信息。

教学视频可以拥有独立页面，并配上学习目标、所需环境和文字步骤。这样既方便直接观看，也方便在需要时快速查找某一步。

发布之后，遇到新的适用条件或更好的做法，可以继续更新原文。说明变化的原因，让文章随着实践一起完善。

写作的起点可以很小：一个问题、一段可运行的代码、一次明确的验证。