skills.rest
JSai23
JSai23COMMUNITY
Explore all skills by this author →
GitHub

wf-doc-a

Generate and update docstrings, rustdoc, JSDoc, and Go package comments from source code.

1|Updated Jan 25, 2026
Search Tags:#automation#documentation#docstrings#rustdoc#api-references#readmes
One-click install
npx skills add https://github.com/JSai23/claude-tooling --skill wf-doc-a
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: wf-doc-a
Source: https://github.com/JSai23/claude-tooling/tree/main/compiled/wf/agentskills/wf-doc-a
Command: npx skills add https://github.com/JSai23/claude-tooling --skill wf-doc-a

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps developers automatically generate and update standard code documentation across languages, ensuring documentation stays in sync with code.

Core Features & Use Cases

  • API documentation: Generate docstrings (Python), rustdoc (Rust), JSDoc (TypeScript/JavaScript), and Go package comments from source.
  • How-To Guides: Create README updates that reflect current APIs and usage examples.
  • Use Case: When refactoring a module, automatically refresh all public-facing docs to match new signatures and behavior.

Quick Start

Generate or update code documentation for the current project by running the relevant documentation action on your codebase.

Frequently Asked Questions about wf-doc-a

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

FAQPage Schema
How do I automatically generate API documentation for Python, Rust, TypeScript, and Go?▼

To automatically generate API documentation for Python, Rust, TypeScript, and Go, this skill parses your source code to produce standard docstrings, rustdoc, JSDoc, and Go package comments. It ensures language-specific conventions and includes type annotations.

What is the best way to update READMEs and API references after refactoring a module?▼

Updating READMEs and API references after refactoring is handled by scanning modified code to refresh public-facing docs. This ensures your documentation reflects new signatures, behavior, and usage examples without manual intervention.

Can I sync docstrings and rustdoc with current code without writing them manually?▼

You can sync docstrings and rustdoc with current code automatically. The skill analyzes your source files to maintain consistency during code changes, applying language-specific conventions and adding examples.

Does this documentation generation skill work with Go package comments and JSDoc?▼

Yes, documentation generation works with Go package comments and JSDoc. It supports Python, Rust, TypeScript, and Go projects to produce aligned API references and READMEs from your existing source code.

When do I need to regenerate code documentation for my project?▼

You need to regenerate code documentation when you refactor a module or change public APIs. This ensures your docstrings, rustdoc, and READMEs stay in sync with current signatures and behavior.

Related Skills

Explore More Software Engineering Skills→
VMRam95VMRam95

agentlens

Analyze directory structures and source code to generate hierarchical documentation and architectural maps.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
TeiNamTeiNam
12

laravel-verification

Automate Laravel project verification for CI/CD pipelines.

Community
Advanced
gkganesh12gkganesh12
1

gk-document

Generate README files, changelogs, API references, JSDoc/docstrings from source code and architecture files.

Community
Advanced