SuperAPI AI 工具集

doc-organizer

办公与效率

查看项目

更新于 10-16 03:59

技能介绍

用途

Doc Organizer 用于对项目文档进行审计、重构与整合,目标是让文档结构清晰、易于维护,并为每个主题建立唯一的权威来源(single source of truth)。它适用于文档随项目发展而自然堆积、变得零散混乱、需要系统整理的情况。

主要能力

该技能围绕文档治理提供以下能力:

  • 文档审计:扫描仓库中的文档文件,包括根目录、docs/、guides/、references/ 下的 **/*.md、**/*.rst、**/*.txt,以及配置文件(YAML、TOML、JSON)中的内联文档注释。对每个文件记录:涵盖的主要主题与子主题、最后一次有意义的更新时间(git log)、与其他文件的重叠(标记重复)、对可能已变更代码的引用(陈旧候选)。最终输出一张汇总表,包含主题、位置、陈旧风险和重复标记。
  • 结构优化:按内容类型约定规范位置——项目概览与快速开始放在 README.md,操作指南与教程放在 guides/,架构与深入解析放在 docs/,API/CLI 参考规范放在 references/ 或 docs/reference/,单功能说明与功能代码放在一起。以表格形式提出移动方案:当前路径 → 目标路径 → 操作(移动/合并/删除/保留),并在执行前等待用户确认。
  • 去重:识别在多个文件中重复出现的内容,选定一个权威位置,用简短摘要加链接替换重复内容。倾向于以更详细的版本作为权威来源。
  • 术语规范化:从文档中提取关键术语(项目名称变体、功能名称、缩写),标记不一致之处(例如 “config” 与 “configuration”、“setup” 与 “set up”),统一采用项目偏好的术语。
  • 导航改进:为长文档(超过 100 行)添加或更新目录,在相关文档之间添加交叉链接,确保 README.md 链接到所有顶层指南与参考文档;若存在多个文档但没有索引页,创建索引页(docs/README.md 或 docs/index.md)。
  • 陈旧检测:将文档声明与当前实现进行比对,包括文档中提到的 CLI 标志/选项与实际 --help 输出或参数解析代码、文档中的配置键与 schema/默认值中的键、文档中的 API 端点与路由定义。将不一致标记为“需要更新”,并给出具体差异。

使用方式

该技能按以下工作流执行:

  1. 审计(Audit):盘点所有文档并对其主题进行分类。
  2. 计划(Plan):提出重构方案(移动、合并、删除),展示计划以供确认。
  3. 执行(Execute):应用这些变更。
  4. 验证(Verify):交叉检查链接、术语和完整性。

关键的交互约束是:结构调整方案必须先展示并获得用户确认,之后才执行。

验证清单

完成后应满足:

  • 没有损坏的内部链接(相对路径可正确解析)
  • 没有孤立文档(每个文档都可从 README 或索引到达)
  • 所有文件术语一致
  • 示例与当前 CLI/API 行为一致
  • 重复内容已消除(每个主题只有一个权威来源)

适用场景

适合在文档规模增长、出现主题重复、术语不统一、导航混乱或文档与代码实现脱节时使用,尤其适用于需要建立长期文档维护规范的项目仓库。

限制

以上资料未提供该技能的具体安装方式、运行环境、依赖条件、支持的平台、收费模式或价格信息;也未说明其在多语言、非文本格式文档或版本控制系统外的具体行为差异。这些内容暂未提供。