skills.rest
mscipio
mscipioCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-generator

Generate README, API, and CLI documentation from source code comments.

Updated Feb 17, 2026
Search Tags:#documentation#code generation#cli#readme#jsdoc#api docs
One-click install
npx skills add https://github.com/mscipio/bilt-transactions-export --skill doc-generator-mscipio
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/mscipio/bilt-transactions-export/tree/main/.opencode/skills/doc-generator
Command: npx skills add https://github.com/mscipio/bilt-transactions-export --skill doc-generator-mscipio

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and maintenance of project documentation, ensuring that code and its documentation remain synchronized and up-to-date, reducing manual effort and errors.

Core Features & Use Cases

  • Automated README Generation: Creates project overview, installation, and usage sections.
  • API Documentation: Generates detailed API references from code comments (JSDoc/docstrings).
  • CLI Documentation: Builds documentation for command-line interfaces.
  • Code Example Extraction: Pulls examples from code comments or test files.
  • Use Case: After updating a function's parameters, this Skill automatically regenerates the relevant API documentation and updates the README's usage examples.

Quick Start

Use the doc-generator skill to create the README.md file for the current project.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I generate API documentation from JSDoc comments and Python docstrings?▼

Generate API documentation from JSDoc comments and Python docstrings by extracting source code structure and annotations to build detailed API references automatically, ensuring the docs stay synchronized with your codebase.

Can I automatically generate a README file from my source code structure?▼

Automatically generate a README file from your source code structure by extracting project overviews, installation instructions, and usage examples to create comprehensive documentation without manual writing.

Does this documentation generator extract code examples from test files?▼

This documentation generator extracts code examples directly from code comments and test files, pulling runnable snippets into your API references and README usage sections automatically.

How do I generate CLI documentation for a command-line interface project?▼

Generate CLI documentation for command-line interface projects by parsing command definitions and structure to build dedicated reference docs that outline usage and available commands.

Can I automate changelog generation by integrating documentation with version control?▼

Automate changelog generation by integrating the documentation process with version control, extracting commit history and code changes to maintain an up-to-date changelog automatically.

What is the best way to keep project documentation synchronized with code updates?▼

Keep project documentation synchronized with code updates by regenerating README files and API references from source code comments whenever functions or parameters change, eliminating manual effort.

Related Skills

Explore More Software Engineering Skills→
armanzeroeightarmanzeroeight
29

api-docs-generator

Generate API documentation from code into HTML or JSON formats.

Community
Intermediate
j0KZj0KZ

documentation-generation

Generate READMEs, changelogs, and API docs from TypeScript sources.

Community
Advanced
bdbchbdbch
2

changelog-writing

Generates changelogs from commit history using 'Keep a Changelog' format and Changeset files.

Community
Intermediate
JansenAnalyticsJansenAnalytics
5

doc-generator

Generate README, JSDoc comments, and API documentation from codebases.

Community
Advanced