docs

Generate structured documentation from JavaScript/TypeScript codebases using inline comments and type definitions.

Updated Jan 26, 2026
One-click install
npx skills add https://github.com/mgoodman60/foremanos --skill docs-mgoodman60
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/mgoodman60/foremanos/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/mgoodman60/foremanos --skill docs-mgoodman60

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill generates clear, maintainable documentation from codebases by extracting meaningful information from inline comments, types, and repository structure.

Core Features & Use Cases

  • Automated Documentation: Create function, class, and API references from JSDoc/TypeScript annotations.
  • API Documentation: Generate consistent API endpoints and usage details for libraries or services.
  • Guidance & Quick References: Produce concise usage notes and README-style docs to improve developer onboarding.

Quick Start

Use the docs skill to generate documentation for a TypeScript file such as rag.ts.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I generate documentation from TypeScript code?

To generate documentation from TypeScript code, this Skill extracts meaningful information from inline comments, type definitions, and repository structure to produce structured function docs and usage notes automatically.

Can I create API reference docs from JSDoc annotations?

Yes, you can create API reference docs from JSDoc annotations. The Skill parses JavaScript and TypeScript annotations to generate consistent API endpoints, usage details, and frontmatter-driven templates.

What's the best way to automate README generation for a JavaScript library?

The best way to automate README generation for a JavaScript library is to use this Skill, which produces concise usage notes and README-style docs from your codebase to improve developer onboarding.

Does this documentation generator work with plain JavaScript or only TypeScript?

This documentation generator works with both JavaScript and TypeScript projects. It applies JSDoc-style annotations and type definitions from either language to extract and structure your API documentation.

Why does my generated documentation lack usage examples?

Your generated documentation may lack usage examples if the inline comments or JSDoc annotations in the codebase do not contain sufficient descriptive text. The Skill extracts information directly from existing comments and types.

How do I structure code comments for automated documentation extraction?

To structure code comments for automated documentation extraction, use JSDoc-style annotations and clear type definitions. The Skill relies on these inline comments and repository structure to generate accurate API references.