跳到正文

从草稿到可执行指南

用完整改写案例串起读者定位、语言、链接、步骤、示例和审阅。

看出草稿缺了什么

准备好后运行脚本,会生成索引。看到结果就可以继续。更多说明请参考文档。

读者可能从搜索直接进入这段,需要知道工具在哪个目录运行、输入是什么、输出如何核对。可先用读者与范围确定一个目标。这里的目标是在已安装 Node.js 的本地环境中,输出一条示例文档记录并验证标题。

写出可复制的操作

用 node --input-type=module 运行下列脚本。示例适用于支持 heredoc 的 Shell。脚本用一个内存数组模拟索引,输出第一条文档的标题。

node --input-type=module <<'NODE'
const index = [{ id: 'search-settings', title: '配置搜索' }]
console.log(index[0].title)
NODE

执行后,终端应显示“配置搜索”。将第一条记录的 title 改成“生成索引”并重跑,可验证输出来自输入数组。需要从多条记录选择子集时,可以按实用配方的步骤处理。

复查改写后的入口

标题指向用户任务。条件和运行方式紧邻代码块,读者可以复制并核对结果。链接加在句中的“实用配方”上,目标页能回答多条记录的处理方法。页面改为真实项目指南时,在同一结构中补上输入文件、命令参数、输出路径和验证过程。

审阅问题本例可核对的答案
示例需要什么环境Node.js 和支持 heredoc 的 Shell
可以观察到什么标准输出显示“配置搜索”
怎样复查边界改动输入标题并重新执行

用文档质量检查验证示例和链接。把最终运行结果记在 PR 中,便于另一位贡献者重跑。