Nm Scribe Doc Generator

Polar Sponsor
爱发电 赞助
.NET 9.0

生成或修复符合人类写作水平的文档

夜市技能——从claude-night-market/lic.

功能概述

夜市技能——从claude-night-market/lic.是一项面向实际任务的技能,主要用于对于代理、钩子和命令的全部经验,请安装 Claude 代码插件。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。

核心要点

  • 使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。
  • 该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。
  • 从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。

使用与执行

实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。

结果检查与注意事项

执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。

Night Market 技能 — 从 claude-night-market/scribe 迁移而来。如需完整体验(含 agent、hook 和命令支持),请安装 Claude Code 插件。

文档生成器

一份文档的成本,等于其所有读者所花费的时间总和。要么值得这份成本,要么就精简它。

生成立足于具体主张的文档,以核心论点(thesis)开篇,并确保每一句话都具备明确价值。诸如“在当今快节奏的世界中”这类空洞套话,以及缺乏实证支撑的模糊表述(如“全面的”“完整的”),均属冗余。此外,任何未承载(carry)、未例证(instance)、未限定(bound)或未复述(repeat)该文档唯一核心论点的句子,也应剔除。

本技能同时强制执行句子级简洁性(禁用松散词汇、过度使用破折号、谄媚式开场白)与文档级经济性(论点先行、每句必有分量、仅对核心论点作必要重复)。完整评估标准详见 Skill(scribe:slop-detector) 模块中的 document-economy.md 文件。

核心写作原则

使用主动语态及作者视角。解释技术选型背后的推理逻辑(例如:为何选用此数据库而非彼数据库),而非堆砌中立模板化内容。仅在需要呈现简短、并列要点时谨慎使用项目符号;将多行项目符号瀑布式列表转为连贯叙述,以保留推理链条。

词汇与风格

避免商业黑话及语言习癖(如镜像式句式结构、破折号滥用)。在 docstring 中统一使用祈使语气(例如:“Validate input”,而非 “Validates input”)。切勿拟人化非生命实体(如“代码希望……”“函数意在表达……”)。

应避免 建议使用
fallback default, secondary
leverage use
utilize use
facilitate help, enable
comprehensive thorough, complete

9. 限制拟人化表达

“lives under”、“speaks to” 等类似短语仅适用于有生命体。

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 — 已获最终用户确认

模式:生成(Generation)

适用于新文档撰写:

步骤 1:定义范围

## Generation Request

**Type**: [README/Guide/API docs/Tutorial]
**Audience**: [developers/users/admins]
**Audience size**: [1 / small team / org / public]
**Read frequency**: [once / weekly / per-invocation]
**Thesis**: [读者必须带走的一句话核心论点]
**Length target**: [约 X 字或 X 节]
**Style profile**: [配置名 或 "default"]

“Thesis” 字段为必填项。 若无法用一句话清晰陈述核心论点,则说明范围尚未就绪。受众规模与阅读频次共同决定读者时间预算(参见 scribe:slop-detector 模块中的 document-economy.md):每日被 50 名用户加载的技能,其预算远高于一份一对一的设计备忘录。

步骤 2:加载风格配置(若存在)

若已存在风格配置文件:

cat .scribe/style-profile.yaml

据此应用语气、词汇及结构规范。

步骤 3:起草内容

以核心论点开篇。 首段须直陈唯一核心论点。即使读者仅阅读首段即停止,也应已掌握关键信息。在正文中部与结尾各复述一次论点;其余所有重复一律删除。

严格遵循上述 10 条核心原则。针对每个章节,请执行以下流程:

  1. 起始即提供最关键信息(陈述论点本身,或其一个明确实例)
  2. 仅当上下文能切实增强价值时才添加(即:是否承载、例证或限定论点?)
  3. 使用具体示例(一个为佐证;两个为强调;三个即属冗余)
  4. 优先采用连贯叙述,而非项目符号
  5. 信息完备即止(不加填充式总结,不写“In conclusion”等重复性结语)

步骤 4:运行冗余检测器(Slop Detector)

Skill(scribe:slop-detector)

修复全部问题后,方可进入下一步。

步骤 5:质量门禁(Quality Gate)

依据以下核查清单进行验证:

句子级:

  • 无一级冗余词(tier-1 slop words)
  • 每千字破折号数量 < 3 个
  • 项目符号占比 < 40%
  • 所有主张均有具体依据支撑
  • 无套路化开场或收尾
  • 具备作者视角
  • 无 emoji(除非明确要求)

文档级(document-economy 模块):

  • 核心论点在首段明确提出,且唯一、清晰(2/2)
  • 超过 80% 的句子承担、例证、限定或复述核心论点(2/2)
  • 核心论点至少复述 3 次;非论点内容的重复均已剔除(2/2)
  • 写作耗时大致正比于(受众规模 × 阅读频次 × 单次阅读耗时)

模式:修正(Remediation)

适用于已有内容的清理优化:

加载:@modules/remediation-workflow.md

步骤 1:分析当前状态

# 获取冗余评分
Skill(scribe:slop-detector) --target file.md

步骤 2:分节处理

对于大文件(>200 行),建议增量式编辑:

## Section: [名称] (第 X–Y 行)

**当前冗余评分**: X.X  
**发现的问题**: [问题列表]

**建议修改**:
1. [修改 1]
2. [修改 2]

**修改前**:
> [当前文本]

**修改后**:
> [建议文本]

是否继续?[Y/n/edit]

步骤 3:保持原意

只修改表达方式(HOW),绝不更改实质内容(WHAT)。若原意不清,务必提问确认。

步骤 4:重新验证

完成编辑后,再次运行 slop-detector,确认冗余评分已改善。

Docstring 专用规则

编辑代码注释时,请遵守:

  1. 仅修改 docstring / 注释文本本身
  2. 绝不改动周边代码
  3. 使用祈使语气(例如:“Validate input”,而非 “Validates input”)
  4. 简洁优于冗长 — 删除所有填充性内容
  5. 若存在 Args/Returns 结构,则予以保留

模块参考

  • 参阅 modules/generation-guidelines.md 获取内容创作模式
  • 参阅 modules/quality-gates.md 获取验证标准

与其他技能的集成

技能 适用场景
slop-detector 初稿完成后、提交审批前
style-learner 生成前,用于加载风格配置
sanctum:doc-updates 面向更广泛的文档维护任务

退出条件

  • 文档内容已完成生成或修正
  • 冗余评分 < 1.5(达到“clean”评级)
  • 质量门禁核查清单全部通过
  • 已获得用户批准
  • 文档中不含 emoji(除非明确指定)

相关专题

更多
Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

0

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

0

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

0

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

0

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

0

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

0

16

XORM框架结构体映射与表结构同步
XORM框架结构体映射与表结构同步

本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。

2026.11.04

0

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

0

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

0

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习