skills.rest
chaorenex1
chaorenex1COMMUNITY
Explore all skills by this author →
WebsiteGitHub

chinese-interface-doc-generator

Extract Chinese comments and docstrings to generate interface documentation in Markdown, HTML, or JSON.

3|Updated Oct 15, 2025
Search Tags:#documentation#markdown#html#json#chinese#code-analysis#interface-docs
One-click install
npx skills add https://github.com/chaorenex1/coding-workflow --skill chinese-interface-doc-generator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: chinese-interface-doc-generator
Source: https://github.com/chaorenex1/coding-workflow/tree/main/skills/chinese-interface-doc-generator
Command: npx skills add https://github.com/chaorenex1/coding-workflow --skill chinese-interface-doc-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automatically analyzes code to generate concise Chinese interface documentation by extracting Chinese comments and docstrings, helping teams quickly understand APIs.

Core Features & Use Cases

  • Interface analysis: detects functions, methods, and API endpoints across Python/JS/TS code.
  • Chinese documentation extraction: prioritizes Chinese comments and docstrings, supports simplified/traditional Chinese.
  • Multi-format output: Markdown, HTML, JSON; supports REST/GraphQL/function interfaces.
  • Reports: generates timestamped interface reports for easy sharing and versioning.
  • Use case: a dev team wants to auto-generate Chinese docs for a large codebase to onboard new contributors.

Quick Start

Provide a code snippet or path and request a complete Chinese interface documentation output.

Frequently Asked Questions about chinese-interface-doc-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate Chinese interface documentation from source code?▼

To generate Chinese interface documentation from source code, provide a code snippet or file path to the tool. It analyzes Python, JavaScript, or TypeScript projects to extract Chinese comments and docstrings, outputting clear API docs.

Can I extract Chinese comments and docstrings from Python and TypeScript projects?▼

Yes, you can extract Chinese comments and docstrings from Python, JavaScript, and TypeScript projects. The tool detects both simplified and traditional Chinese text across functions, class methods, and API endpoints.

What is the best way to output interface docs in Markdown, HTML, or JSON formats?▼

The best way to output interface docs in Markdown, HTML, or JSON is to use an automated code analysis tool. It processes source code and delivers multi-format documentation, supporting REST, GraphQL, and function interfaces.

Does Chinese interface documentation generation work for large codebases?▼

Yes, Chinese interface documentation generation works for large codebases. It applies to projects of varying sizes, automatically detecting functions and API endpoints to help onboard new contributors with timestamped reports.

How to create timestamped interface reports for versioning and team sharing?▼

To create timestamped interface reports for versioning and team sharing, run the code analysis tool on your project. It generates timestamped documentation reports in your chosen format, ensuring easy sharing and version tracking.

Related Skills

Explore More Software Engineering Skills→
DexploarerDexploarer
6

comment-generator

Generate structured code comments and docstrings for JavaScript/TypeScript, Python, and Java.

Community
Basic
ViewWayViewWay

glmv-pdf-to-ppt

Convert PDFs into HTML slide decks with outline JSON and summary Markdown.

Community
Intermediate
jie023jie023
36

test-api-basic-function

Automate baseline API testing for REST and HTTP endpoints with Markdown reports.

Community
Intermediate
CloudyWingCloudyWing

translate-zh-en

Translate technical documentation between Traditional Chinese and English while preserving code blocks.

Community
Intermediate