mcpField
Z
zh-docgen

zh-docgen

github.com/laolaoshirenドキュメント90099 回インストール2 日前に更新
リポジトリ

zh-docgen について

zh-docgenは、コードベースから中国語のプロジェクト文書を作成するスキルです。構成やコードを調べ、概要、セットアップ、APIリファレンス、例、FAQを含むMarkdownを生成します。

主な機能

  1. 01構成を調査してプロジェクト種別を判別
  2. 02コードのシグネチャとコメントを抽出
  3. 03概要とアーキテクチャ図を生成
  4. 04セットアップとAPIリファレンスを作成
  5. 05例とFAQを追加

活用シーン

  1. 01既存プロジェクトの中国語文書を作成
  2. 02コードからAPI文書を生成
  3. 03インストールと実行手順を文書化

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/laolaoshiren/claude-code-skills-zh --skill zh-docgen

インストール後、Claude Code で/zh-docgenを入力して読み込まれたか確認します。

詳細

プロジェクトの README より

中文文档生成器

触发条件

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

工作流程

  1. 扫描项目结构 — 识别项目类型（Web 应用/CLI 工具/库/服务）
  2. 分析代码 — 提取模块、函数、类、接口的签名和注释
  3. 生成文档 — 输出以下文档：
生成内容
  • 项目概述 — 中文简介、技术栈、架构图（Mermaid）
  • 快速开始 — 安装、配置、运行步骤
  • API 参考 — 自动生成的接口文档
  • 使用示例 — 常见场景的代码示例
  • 常见问题 — FAQ 部分

输出格式

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

技巧

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

コメント

Markdown 対応