SuperAPI AI 工具集

doc-generator

测试与质量

查看项目

更新于 10-15 17:20

技能介绍

doc-generator 是一个文档写作技能,核心主张是文档的价值应抵得上读者花的时间:内容要基于具体论断、先给论点,并让每句话都发挥作用。

用途与能力:生成新文档(README、指南、API 文档、教程)或对已有内容做整改;同时在句子层面清除“套话词汇”、破折号滥用、谄媚开头,在文档层面保证论点先行、删去与论点无关的重复。支持加载风格配置(如 .scribe/style-profile.yaml)后按其语气、词汇与结构写作。写代码注释时要求用祈使语气(“Validate input”而非“Validates”),只改注释文本、不动周围代码,保留 Args/Returns 结构。

使用方式:生成模式先定义范围,必须写明类型、受众层级、受众、规模、阅读频率、一句话论点、长度目标与风格配置;受众层级未提供时应询问而非猜测。随后加载风格、起草内容、运行脚本 uv run --with pyyaml python scripts/slop_score.py --audit <files> 检查 AI 痕迹,再走质量门与用户确认。整改模式先分析现状,对超过 200 行的大文件按段落逐段提出改动并请用户确认,保留原意只改表达,改后重跑检查。

适用场景与限制:适合需要面向特定读者、严格控制废话与 AI 腔调的文档工程。不适用于把外部文件转为 Markdown,也不用于单纯扫描现有文本中的 AI 模式。资料未提供具体收费、价格与平台信息。