代码文档撰写

技能简介

覆盖开发者文档全场景，从接口说明到项目导读，建立清晰的技术写作规范。帮助团队沉淀知识资产，降低新成员上手成本，维护长期可读的代码生态。

能做什么

• 梳理代码结构与模块边界
• 总结技术栈、依赖与风险点
• 输出可复用的工程说明文档

使用说明

• 提供项目目录或目标模块。
• 按结构梳理实现路径与依赖。
• 输出结论并复核关键判断。

npm install

npm run dev

英文名

code-documentation

输入与输出

见下方输入与输出表格。

风险提示

• 自动分析结论可能忽略业务上下文，关键设计判断仍需工程人员确认。
• 若直接操作仓库或脚本，请先确认执行范围，避免误改核心代码。
• 涉及私有仓库或内部依赖时，应按权限边界处理访问和输出内容。

来源信息

原始链接：https://github.com/skillcreatorai/Ai-Agent-Skills
来源类型：GitHub 开源仓库