关于 scribe
scribe 是依据所提供资料编写或审计技术文档的 Skill,侧重可追溯、可执行的说明,并保留来源细节、报告未解决的缺口。
主要功能
- 01就地创建或修订文档
- 02将文档内容追溯至绑定来源
- 03核对命令、路径、值和顺序
- 04审计文档但不修改文档
适用场景
- 01依据参考资料编写技术说明
- 02对照来源修订现有文档
- 03审计文档覆盖情况并报告内容缺口
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ akshay-diwadkar/ first-four-hours --skill scribe安装后在 Claude Code 中输入/scribe确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
skill-protocol.jsonagents/openai.yamlreferences/audit.mddocument-bundle.mdmte-1.mdsource-grounding.mdwrite.mdschemas/document-bundle.schema.jsonglossary.schema.jsonscripts/_diagnostic_contract.py_document_contract.py_skill_protocol_runtime.pyaudit_document.pybundle_workspace.pycheck_document_language.pycheck_document.pycli.pyseal_document.pytemplates/document-bundle.json详细介绍
Scribe
用途与权限
将提供的技术来源转化为读者可以执行和追溯的文档。绝不编造来源中的事实;保留受约束的命令、路径、值、顺序、警告和恢复步骤。验证并不能证明事实独立真实。
仅在拥有创建或修订文档的权限时写入;隐式调用绝不授予写入或修复权限。审计是独立操作,只写入审计报告。审计不得修改文档、文档包或绑定的来源。
根据请求和来源确定受众、读者任务和范围。只有当来源无法确定会影响发布或内容策略的重要选择时,才向用户询问;缺少来源事实属于未解决的缺口。在确定文档计划之前、发生失败或方向变更之后,以及报告完成之前,都要查看 reason。最终报告和停止报告应按照其检查点追踪要求列出 reason 检查点。
编写与审计
每份文档都是一项交付物:在编写模式下,应在用户指定的位置原地创建或编辑实际文件。两种操作都会根据 Document Bundle 和 Source Grounding,检查 document-bundle.json 列出的每份文档是否与其绑定的来源相符。文档包属于支持状态:应在仓库外的临时目录中,使用 templates/document-bundle.json 创建。列出多份文档即可在一次运行中处理它们。
要编写文档,请遵循 Write;其中的语言检查适用 MTE-1,这是一套仅受 ASD-STE100 启发的原创规范:绝不可声称符合官方 ASD-STE100,也不可暗示此技能包含其认可的词典。write 命令只检查文档,不会编辑任何文件:
python /absolute/skill-root/scripts/cli.py --repo-root /absolute/repo \
--input bundle=/absolute/temp/document-bundle.json --format json write
要进行审计,请遵循 Audit:以相同方式运行 audit,并使用 --input slug=<audit-slug>。它只会写入 .first-four-hours/scribes/<slug>/scribe-audit.md,每份文档对应一个章节。
完成
只有当 write 返回 result.status: complete 时,编写才算完成。如果返回 incomplete,只剩下列出的 gaps:报告每个缺口及其负责人。否则,按每条诊断中的 required_action 指示,修复其中 document 指定的文档或文档包,然后重新运行。只有当 audit 返回 status: complete 时,审计才算完成;报告 scribe-audit.md 的路径,以及每份文档的 document_sha256 和检查结果。如果仍有重要的读者任务未得到支持,即使结果通过,也不算完成:应报告确切缺口及其下一位负责人。最后提供一项与当前结果相符的可选后续步骤:给出一个围栏代码块,其中包含自包含的提示词,并注明所需的任何仓库、议题、PR 或制品;或者说明无需后续步骤。只有用户回答“是”才会启动后续步骤,并通过提示词中指定的任意技能启动;但 charter、diagnose 或 ticket 步骤必须由用户以其 /<skill> 命令运行。