SuperAPI AI 工具集

readme-beautifier

办公与效率

查看项目

更新于 10-15 22:15

技能介绍

用途:把结构混乱或格式不一致的 README 整理成结构清晰、格式统一、观感专业的版本,只改格式与结构,不改内容。

主要能力:统一标题层级(h1 仅用于项目名、层级不跳级、同级粒度一致);把一句话简介放在项目名下方;梳理章节职责与常见顺序(是什么→快速开始→用法→配置→目录结构→贡献→许可);统一列表符号与缩进、有序列表用 1. 自动编号;为代码块标注语言、行内代码加反引号、去掉多余 $ 前缀;整理表格对齐与表头;让链接文字有意义并检查空链接与占位链接;规范空行、中英文空格与文件末尾换行;若原有徽章则集中到项目名下方、简介上方;章节超过 6 个时建议加目录,但需用户授权才添加,已有目录锚点损坏则修复而非删除。

使用方式:按“阅读 README→对照清单诊断→列出改动计划→执行美化→输出摘要”的流程进行。用户指定本地文件时直接编辑该文件并返回路径与简短摘要,不在对话中重复长 README;若 README 是粘贴的且无可写目标,则返回完整美化内容加摘要。输出格式参考 references/output-template.md。

适用场景:布局美化、格式统一、结构梳理。若用户想核对 README 与代码/配置/API 是否一致或是否过时,或做文档内部一致性审计,应改用 hai-audit-docs;若想围绕当前结论重写内容,应改用 hai-rewrite-doc。

限制:不新增或删除内容,不编造信息,不改变技术内容(命令、配置项、代码示例逻辑),不翻译,不加 emoji、分隔线或 ASCII 艺术字,不重命名文件(输出仍为 README.md)。缺失的一句话简介、空章节、缺失的贡献章节只作为超出范围的内容缺口在摘要中说明。极短 README(少于 10 行)只修格式不补长度;超长 README(超过 300 行)优先修结构问题;多语言 README 只处理当前文件。README 已足够好时不强行改动。