\ud83e\udd9e Nm — 文档生成器

v1.0.0

一键生成或修复项目文档,模仿人类写作风格,自动检测并剔除低质量内容,输出专业级文档。

0· 23·1 当前·1 累计
下载技能包 项目主页
最后更新
2026/4/20
0
安全扫描
VirusTotal
无害
查看报告
OpenClaw
安全
high confidence
技能需求与运行指令与文档生成/修复工具一致,未索取无关凭据或额外安装。
评估建议
该技能功能如其所述:读取风格/配置文件,扫描并重写文档,调用 slop-detector/质量门。安装前请审查并信任引用的配套技能(如 scribe:slop-detector、leyline:markdown-formatting、sanctum:doc-updates),确认这些组件不会访问外部端点或请求密钥。同时抽查 .scribe/style-profile.yaml,确保愿意让代理读写其将编辑的仓库文件。若发现 slop-detector 或其他引用技能需要网络访问或凭据,请重新评估(这将改变本评估)。...
详细分析 ▾
用途与能力
名称/描述(文档生成与修复)与产物一致:仅含指令的 SKILL.md 及三个写作模块。声明的配置路径(night-market.scribe:shared 与 night-market.scribe:slop-detector)与该技能预期的 linter/质量检查器集成相符。
指令范围
指令要求代理读取本地仓库文件(如 .scribe/style-profile.yaml、目标文档),执行简单 shell 检查(cat、grep),并调用其他技能(scribe:slop-detector、leyline:markdown-formatting、sanctum:doc-updates)。这适合编辑文档,但意味着技能将访问仓库文件并依赖引用技能的行为。
安装机制
无安装规范或代码文件——仅含指令——因此技能本身不会下载或写入磁盘任何内容。
凭证需求
技能未请求环境变量或外部凭据。唯一需要的是相关 Night Market 组件的配置路径(shared 与 slop-detector),与文档行为一致。
持久化与权限
always 为 false,技能未请求提升或持久平台权限。可由代理自主调用(平台默认),但无迹象表明其会修改其他技能或系统级设置。
安全有层次,运行前请审查代码。

运行时依赖

无特殊依赖

版本

latestv1.0.02026/4/20

- nm-scribe-doc-generator 技能初始发布。 - 基于人本风格与有据主张,自动化高质量文档生成与修复。 - 强制执行清晰写作原则:主动语态、文档字符串用祈使语气、最少项目符号、避免商业行话或模糊语言。 - 集成“slop-detector”保持风格一致,并提供生成与修复模式的逐步工作流。 - 包含严格质量门标准与结构化审批流程,确保输出符合文档标准。

无害

安装命令

点击复制
官方npx clawhub@latest install nm-scribe-doc-generator
镜像加速npx clawhub@latest install nm-scribe-doc-generator --registry https://cn.longxiaskill.com

技能文档

Night Market Skill — ported from claude-night-market/scribe. For the full experience with agents, hooks, and commands, install the Claude Code plugin. # 文档生成器 文档必须基于具体事实,而非抽象形容词。我们避免“在当今快节奏的世界中”这类套话,直接提供有用信息。每个断言都应有证据支撑,例如具体版本号或请求速率,而非“全面”这类模糊描述。 ## 核心写作原则 我们优先采用作者视角和主动语态,以保持一致的团队语调。这意味着要解释技术选择背后的原因,例如为何选择某个数据库而非另一个,而不是提供中性模板。子弹列表仅用于可行动总结;多行子弹瀑布应转换为短段落以保留细节。 ### 词汇与风格 避免商业行话和语言习惯,如镜像句型或过多 em 破折号。我们对 docstring 使用祈使语气(例如“验证输入”),严格避免将非生命体拟人化。 | 避免 | 使用 | |------------|-----| | fallback | default, secondary | | leverage | use | | utilize | use | | facilitate | help, enable | | comprehensive | thorough, complete | ### 9. 限制拟人化表达 “位于…之下”、“说明” 等短语仅适用于有生命的事物。 ### 10. Docstring 使用祈使语气 “Validate” 而非 “Validates”(遵循 PEP 257、pydocstyle、ruff)。 ## 必需的 TodoWrite 项 1. doc-generator:scope-defined - 确定目标文件与类型 2. doc-generator:style-loaded - 应用风格配置(如有) 3. doc-generator:content-drafted - 创建初稿 4. doc-generator:slop-scanned - 检查 AI 痕迹 5. doc-generator:quality-verified - 通过原则清单 6. doc-generator:user-approved - 获得最终批准 ## 模式:生成 针对新文档: ### 步骤 1:定义范围 ``markdown ## 生成请求 类型: [README/Guide/API docs/Tutorial] 受众: [developers/users/admins] 长度目标: [约 X 字或章节] 风格配置: [配置名或 "default"] ` ### 步骤 2:加载风格(如有) 若存在风格配置: `bash cat .scribe/style-profile.yaml ` 应用语调、词汇与结构指南。 ### 步骤 3:起草内容 遵循上述 10 条核心原则。对于每个章节: 1. 先给出关键信息 2. 仅在有价值的上下文中添加背景 3. 使用具体示例 4. 优先段落而非子弹列表 5. 信息完整即结束(无需总结填充) ### 步骤 4:运行 Slop 检测器 ` Skill(scribe:slop-detector) ` 修正所有发现项后再继续。 ### 步骤 5:质量门 对照清单验证: - [ ] 无一级 slop 词 - [ ] em 破折号 < 3 个/千字 - [ ] 子弹比例 < 40% - [ ] 所有断言都有具体依据 - [ ] 无公式化开头或结尾 - [ ] 具备作者视角 - [ ] 无表情符号(除非明确要求) ## 模式:修复 用于清理已有内容: 加载:@modules/remediation-workflow.md ### 步骤 1:分析现状 `bash # 获取 slop 得分 Skill(scribe:slop-detector) --target file.md ` ### 步骤 2:分段处理 对于大文件(>200 行),逐步编辑: `markdown ## 章节:[名称](行 X-Y) 当前 slop 得分:X.X 发现问题: [列表] 建议修改: 1. [修改 1] 2. [修改 2] 修改前: > [原文] 修改后: > [建议文本] 继续? [Y/n/edit] ` ### 步骤 3:保留意图 绝不改变“说什么”,只调整“怎么说”。若含义不清,请询问。 ### 步骤 4:再验证 编辑后重新运行 slop-detector,确认改进。 ## Docstring 专用规则 编辑代码注释时: 1. 仅修改 docstring/注释文本 2. 绝不改动周边代码 3. 使用祈使语气(“验证输入”而非“验证输入”) 4. 越简洁越好——删除填充词 5. 保持 Args/Returns 结构(如存在) ## 模块参考 - 参见 modules/generation-guidelines.md 获取内容创建模式 - 参见 modules/quality-gates.md` 获取验证标准 ## 与其他技能集成 | 技能 | 使用时机 | |-------|-------------| | slop-detector | 起草后、批准前 | | style-learner | 生成前加载配置 | | sanctum:doc-updates | 用于更广泛的文档维护 | ## 退出条件 - 内容已创建或修复 - Slop 得分 < 1.5(清洁等级) - 通过质量门清单 - 获得用户批准 - 无表情符号(除非指定)
数据来源ClawHub ↗ · 中文优化:龙虾技能库