SkillFeeder › 全部 Skill › 工程开发 › code-documentation
自动生成README、API文档、内联注释等专业代码文档
code-documentation
code-documentation 是 SkillFeeder 收录的Agent Skill,来自 GitHub 仓库 bytedance/deer-flow,★ 85,186。自动生成README、API文档、内联注释等专业代码文档。适合开发者、开源维护者、技术写作者。场景是工程开发 · 重构架构。能做的事包括生成带徽章和使用示例的README.md、从源码分析生成结构化API参考文档、输出架构说明与开发者指南。打开 GitHub 自行安装。
能做什么
- 生成带徽章和使用示例的README.md
- 从源码分析生成结构化API参考文档
- 输出架构说明与开发者指南
原文简介
Use this skill when the user requests to generate, create, or improve documentation for code, APIs, libraries, repositories, or software projects. Supports README generation, API reference documentation, inline code comments, architecture documentation, changelog generation, and developer guides. Trigger on requests like "document this code", "create a README", "generate API docs", "write develope
同场景推荐
- ai-first-engineering所在仓库 affaan-m/ECC,仓库 ★ 300,014建立AI主导开发的团队工程规范与评审机制
- architecture-decision-records所在仓库 affaan-m/ECC,仓库 ★ 300,014自动生成编号ADR文档,记录架构决策的上下文、选项与影响。
- code-review-and-quality所在仓库 addyosmani/agent-skills,仓库 ★ 114,402自动执行五维代码审查并给出合并建议
- code-simplification所在仓库 addyosmani/agent-skills,仓库 ★ 114,402把能跑的代码变清晰,行为零改动
- documentation-and-adrs所在仓库 addyosmani/agent-skills,仓库 ★ 114,402自动生成带决策背景的ADR文档和设计说明
- simplify-codebase所在仓库 tt-a1i/archify,仓库 ★ 94,977自动识别并安全删除死代码、冗余层和过载抽象
- aria-deprecated-role所在仓库 thedaviddias/Front-End-Checklist,仓库 ★ 74,681自动扫描并替换 HTML 中已废弃的 ARIA role 属性
- security-audit所在仓库 cloudflare/security-audit-skill,仓库 ★ 26,305发现真实信任边界漏洞,提供可复现证据、优先级和最小修复方案