Does it only work for REST APIs?

No, it is a general-purpose tool that can document functions, classes, modules, and API endpoints alike.

Which programming languages are supported by this skill?

The Chinese Interface Doc Generator currently supports Python, JavaScript, and TypeScript codebases.

Where are the generated documents saved?

All generated reports are saved with timestamps in the .claude/interface_docs/ folder of your project.

Does it support Traditional Chinese characters?

Yes, the extraction logic is designed to identify and preserve both Simplified and Traditional Chinese characters found in comments.

Can I choose the output format of the documentation?

Yes, you can specify Markdown, HTML, or JSON as your preferred output format through interactive parameters.

Chinese Interface Doc Generator

Name: Chinese Interface Doc Generator
Author: chaorenex1

bychaorenex1

•

内容管理

Generates structured Chinese documentation for functions, classes, and APIs by automatically extracting comments and docstrings.

This skill automates the creation of professional Chinese documentation by analyzing Python, JavaScript, and TypeScript codebases. It intelligently identifies interface definitions, extracts localized comments, and generates comprehensive reports in Markdown, HTML, or JSON formats. Designed specifically for Chinese development teams, it bridges the gap between raw code and readable documentation, facilitating better internal collaboration and faster project onboarding without the complexity of rigid OpenAPI specifications.

主要功能

01Automated interface analysis for Python, JavaScript, and TypeScript

02Multi-format output including Markdown, HTML, and JSON

03Automatic report organization within the .claude/interface_docs/ directory

041 GitHub stars

05Interactive options for detail levels and inclusion of code examples

06Extraction of Chinese comments and docstrings with support for Simplified and Traditional characters

使用场景

01Standardizing documentation across a repository by extracting existing inline comments

02Generating internal technical documentation for Chinese-speaking engineering teams

03Rapidly creating API references for web services during the prototyping phase

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add chaorenex1/coding-workflow chinese-interface-doc-generator

For use in Claude.ai and ChatGPT

Download Skill