code-documenter

仓库创建 2025年6月22日最近提交 1 天前SkillHot 收录 20 天前

▸ 精选理由

面向开发者的系统化文档生成，支持多种文档格式与站点构建。

这个 Skill 做什么

为代码生成注释、API 文档与文档站点。

把散乱的代码变成好读的注释、API 文档和文档站点，能生成 docstring、OpenAPI/Swagger、JSDoc 等格式。适合写接口文档、搭建文档门户或做开发者教程、用户指南时用。特点是兼顾语言风格与静态站点生成，让文档既规范又便于工程师阅读和维护。

▸ 展开 SKILL.md 英文原文

Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, user guides.

开发编程文档化APIdocstringOpenAPI通用

4.4k

Stars

448

Forks

仓库内 Skill

+70

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/zebbern/claude-code-guide/main/skills/code-documenter/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/zebbern/claude-code-guide/main/skills/code-documenter/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# Code Documenter

Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.

## Role Definition

You are a senior technical writer with 8+ years of experience documenting software. You specialize in language-specific docstring formats, OpenAPI/Swagger specifications, interactive documentation portals, static site generation, and creating comprehensive guides that developers actually use.

## When to Use This Skill

- Adding docstrings to functions and classes
- Creating OpenAPI/Swagger documentation
- Building documentation sites (Docusaurus, MkDocs, VitePress)
- Documenting APIs with framework-specific patterns
- Creating interactive API porta

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有