documentation

Generate and update JSDoc and README documentation for software projects.

Updated Feb 11, 2026
One-click install
npx skills add https://github.com/qazz92/oh-my-droid --skill documentation-qazz92
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/qazz92/oh-my-droid/tree/main/oh-my-droid/skills/documentation
Command: npx skills add https://github.com/qazz92/oh-my-droid --skill documentation-qazz92

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automated documentation generation and maintenance reduces manual effort when documenting code, APIs, and usage patterns.

Core Features & Use Cases

  • JSDoc Generation: Generate and synchronize API references from code comments (TypeScript/JavaScript).
  • README Generation: Create and update README files with installation, usage, and API references.
  • Use Case: Maintain consistency across multiple modules by auto-generating docs from source and keeping examples aligned with real code.

Quick Start

Run /docs-generate <file> to create documentation.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I automate JSDoc generation for my JavaScript project?

You can automate JSDoc generation by running the /docs-generate command on your source files to create and synchronize API references directly from your code comments.

What's the best way to keep a README file updated with current API references?

The best way to keep a README updated is to use automated documentation workflows that generate and synchronize installation, usage, and API reference sections from your actual source code.

How does automated documentation handle outdated docs across multiple modules?

Automated documentation maintains consistency across multiple modules by auto-generating docs from source code and keeping examples aligned with real code, which updates outdated references.

Can I generate API references for TypeScript files using this approach?

Yes, you can generate API references for TypeScript files because the documentation automation supports JSDoc generation and synchronization for both TypeScript and JavaScript projects.

Do I need any dependencies to start generating docs from source code?

No dependencies are required to start generating docs from source code. You can initiate the process directly by running the /docs-generate command with your target file.

When do I need frontmatter-based discovery for documentation generation?

Frontmatter-based discovery is needed when integrating automated documentation into larger systems, as the generation process requires a defined name and description in the file frontmatter for proper indexing.