本文へ移動
cccskills
無料GitHub で公開

zh-docgen

中文文档生成器 - 从代码库自动生成中文技术文档

インストール方法を見る

含まれるファイル(1)

  • SKILL.md1.0 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

中文文档生成器

触发条件

当用户要求生成文档、写技术文档、生成 API 文档、项目说明时激活此技能。

工作流程

  1. 扫描项目结构 — 识别项目类型(Web 应用/CLI 工具/库/服务)
  2. 分析代码 — 提取模块、函数、类、接口的签名和注释
  3. 生成文档 — 输出以下文档:

生成内容

  • 项目概述 — 中文简介、技术栈、架构图(Mermaid)
  • 快速开始 — 安装、配置、运行步骤
  • API 参考 — 自动生成的接口文档
  • 使用示例 — 常见场景的代码示例
  • 常见问题 — FAQ 部分

输出格式

生成一个或多个 Markdown 文件,中文为主,技术术语保留英文。

技巧

  • 优先读取已有 README、package.json、pyproject.toml 获取项目元信息
  • 分析 import/require 语句推断依赖关系
  • 从 docstring/JSDoc 提取已有文档

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

依据真实 OpenAPI、路由实现和现有测试生成并验证 API 测试。用于用户要求测试接口、补集成测试、验证 API 契约、生成回归用例或排查接口兼容性时;区分“生成测试”和“执行请求”的授权,不猜测状态码、响应结构或 SLA,不在未确认环境中发送写请求。

日本語の概要は準備中です。原文の説明を表示しています。

laolaoshiren/claude-code-skills-zh8812026年10月12日 更新

Changelog 生成器 - 从 Git 历史自动生成 CHANGELOG

日本語の概要は準備中です。原文の説明を表示しています。

laolaoshiren/claude-code-skills-zh8812026年10月12日 更新

数据库迁移助手 - Schema 对比、迁移脚本生成

日本語の概要は準備中です。原文の説明を表示しています。

laolaoshiren/claude-code-skills-zh8812026年10月12日 更新

审计 Node.js、Python、Go、Rust、JVM、Ruby 项目的依赖漏洞、版本健康度与许可证事实;当用户要求检查 package.json、lockfile、requirements、go.mod、Cargo.toml、pom.xml、Gemfile.lock,或生成不改依赖的中文审计报告时使用

日本語の概要は準備中です。原文の説明を表示しています。

laolaoshiren/claude-code-skills-zh8812026年10月12日 更新

ds-mapper

無料

项目目录结构地图 - 生成带说明的可视化目录树,快速理解任意代码库

日本語の概要は準備中です。原文の説明を表示しています。

laolaoshiren/claude-code-skills-zh8812026年10月12日 更新

环境变量管理器:扫描、校验、同步 .env 文件,生成安全配置模板

日本語の概要は準備中です。原文の説明を表示しています。

laolaoshiren/claude-code-skills-zh8812026年10月12日 更新

laolaoshiren のスキルをすべて見る

このスキルの問題を報告する