文本与正则表达式
用 Markdown 整理易读的 README 步骤
使用工具
反复被问用法，可能不是缺信息，而是难找到。长背景和埋在段落里的命令让人不知何时能开始。对照源码与预览，按读者第一项实际任务重新排序。
让标题成为路标
# Example Tool
A small example for checking a local text file.
## Before you start
Use a fictional input file.
## Try one example
Follow the steps below.
## If the result differs
Check the input and selected options.粘贴后确认文档标题高于准备、示例、排错各节。标题表达层级，不只是字号。按“先试一次”“结果不同”等任务命名，读者无需从头读完也能定位。
标题过密会打断阅读。每节围绕一个问题和必要步骤，先简述前提，再通过示例结果深入解释。预览不评分写作质量，需人工只读标题检查流程是否清楚。
分开输入与预期输出
## Input
```json
{"name":"demo","enabled":true}
```
## Expected output
```text
Validation succeeded.
```围栏代码块把 JSON 和换行组织起来。Validation succeeded. 只是文档样例，不是预览实际验证结果。输入输出分开，避免读者把结果行也复制成命令或数据。
代码前说明使用位置和需替换的值，使用虚构数据，勿混入生产凭据或地址。显示成功不证明命令可执行，文档操作须另在项目安全环境验证。
比较用表格，步骤用编号
| Option | Example | Meaning |
| --- | --- | --- |
| mode | preview | Inspect without applying |
| limit | 10 | Maximum displayed rows |多个设置按同样维度比较适合表格，顺序操作适合编号步骤。不要把长流程塞入单元格，以免窄屏反复横滚。
mode 和 limit 是虚构文档示例，不是实际工具选项。替换时核实真实设置，并区分示例值与默认值，让读者知道 10 是例子还是未设置时采用的值。
源码换行不一定是新段落
First line
Second line
Another paragraph前两行源码属于一段，空行后才是另一段。编辑器折行不同于语义分段，应每段一个主题，用空行分隔并对照预览。
缩进或未关闭的代码围栏会把后续标题吞入其他元素。后半全变代码时，应回看起始围栏。先逐一调整边界、缩进、空行，不要立即重写整节。
预览限制与发布行为不同
预览不获取外部图片、不执行原始 HTML，链接也不作为可跳转导航。图片不显示不能证明 URL 错误。HTML 输出可含安全链接，但发布站点的链接检查是另一项工作。
最终平台可能使用不同 Markdown 扩展、锚点、图片规则和 CSS。这里确认结构后还需检查发布平台，不能保证完全同样样式或相对链接存在，应区分已验证与未验证。
最后以新读者视角找四个答案：准备什么、输入什么、什么结果算成功、失败看哪里。把散落答案围绕任务集中，困惑分支处的短解释可能比增加泛文更有用。