SuperAPI AI 工具集

codegen-doc

通用与其它

查看项目

更新于 10-16 01:31

技能介绍

用途:本 Skill 指导 Agent 基于当前项目/代码仓库生成文档,支持四种类型:论文章节、项目梳理、重点问题、简历项目描述。面向给导师、评委、HR、领导看的内容;若用户需要给新同事上手的新人文档、架构文档、代码导读、onboarding,则应改用 project-docs。

任务识别:用户提到“论文章节、系统设计、总体设计、详细设计”时走 reference/thesis-chapter.md;提到“项目梳理、项目文档结构、按格式梳理”时走 reference/overview.md;提到“重点问题、技术难点、待解决问题、项目风险”时走 reference/key-issues.md;提到“简历项目描述、项目经历、按简历格式”时走 reference/resume-format.md。

怎么读项目:四种类型都要先读代码,不必读完所有源文件,分三步。看轮廓:目录树(排除 node_modules / build / dist / vendor)、构建和依赖文件(package.json / pom.xml / requirements.txt / go.mod 等)、README,得出项目用途和技术栈。看骨架:入口文件、路由或接口定义、配置文件、每个顶层目录的一句话职责。再按类型补读:论文章节读部署相关文件与模块调用关系;项目梳理读用户格式点名要的部分(如“核心接口”就去读路由表);重点问题读 TODO / FIXME、README 的 Known issues / Limitations、异常处理和兜底逻辑;简历项目描述关注可量化项(接口数、模块数、测试覆盖),只在真有依据时写。

使用时机与原则:适用于用户要求“根据当前项目”“根据代码”“按这个格式”生成上述文档。技术栈、模块名、接口名要与代码逐字一致,不凭印象改写。原则是不编造(仓库中未出现的内容不写入)、有据可依(从代码、注释、README、文档中抽取)、格式遵从(用户提供格式/模板时严格按格式组织输出)。资料未提供具体安装命令、收费方式、平台限制等细节。