SuperAPI AI 工具集

codebase-documenter

写作与研究

查看项目

更新于 10-15 17:21

技能介绍

用途:为代码库编写面向初学者的完整文档,涵盖 README、架构指南、代码注释与 API 文档。

主要能力:提供四类文档的结构模板——README(项目简介、快速开始、项目结构、核心概念、常见任务、故障排查)、架构文档(系统设计、目录结构、数据流、关键设计决策、模块依赖、扩展点)、代码注释(函数/方法说明、复杂逻辑注释,解释“为什么”而非“做了什么”)以及 API 文档(功能、端点、认证、请求/响应格式、用法示例、常见错误、相关端点)。核心原则包括:先讲“为什么”、渐进式披露、提供上下文与示例、假设读者无预备知识、使用图示与文件树、帮助用户 5 分钟内跑起来。

使用方式:先分析代码库(入口点、依赖、核心概念、配置、现有文档),再按需选择文档类型,使用 assets/templates/ 下的模板(README.template.md、ARCHITECTURE.template.md、API.template.md、CODE_COMMENTS.template.md)填充项目信息并添加真实示例,最后以初学者视角复查清晰度、完整性与示例可运行性。复杂或企业级代码库可参考 references/documentation_guidelines.md 与 references/visual_aids_guide.md。

适用场景:新项目或缺 README、多模块复杂架构、晦涩代码段、HTTP/API 端点,以及需要统一大型项目文档规范的场景。文档类型优先顺序为 README → 架构 → API → 注释。

限制:本资料未提供该技能的安装命令、收费方式、平台支持或运行环境要求等具体信息。