write-docs

Generate documentation pages from a package's TypeScript/JS source code.

4|Updated Oct 10, 2025
One-click install
npx skills add https://github.com/JanuaryLabs/deepagents --skill write-docs-januarylabs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/JanuaryLabs/deepagents/tree/main/.claude/skills/write-docs
Command: npx skills add https://github.com/JanuaryLabs/deepagents --skill write-docs-januarylabs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automatically generates documentation for a software package by analyzing its source code, reducing manual writing time and aligning docs with the codebase.

Core Features & Use Cases

  • Analyze a package's source under packages/<package-name>/src/ to identify its public exports (classes, functions, types) and architecture.
  • Generate comprehensive documentation pages including an overview, getting started, and per-feature sections.
  • Spawn multiple doc-writer sub-agents in parallel to produce individual pages, then assemble and update metadata.

Quick Start

Provide the target package name and let the skill generate docs automatically from its source.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I auto-generate package documentation from TypeScript source code?

You can auto-generate package documentation by analyzing TypeScript source code to identify public exports, then spawning parallel sub-agents to write individual feature pages and an overview. This approach parses your codebase directly to produce structured markdown documentation.

What is the process for creating per-feature documentation pages from a codebase?

Creating per-feature documentation pages involves parsing the package's source to extract its architecture and public exports, then generating one dedicated page per feature. The system assembles these pages and updates the project's metadata file automatically.

Can I automatically extract public exports and architecture for package docs?

Yes, you can automatically extract public exports and architecture for package docs. The tool analyzes the source directory to identify classes, functions, and types, using this structure to generate comprehensive getting started and feature pages.

Does documentation generation work with JavaScript and TypeScript source files?

Documentation generation works by parsing TypeScript and JavaScript source files. It reads the source directory to identify public exports and architecture, then produces an overview and individual feature pages from the analyzed code.

What's the best way to write markdown docs for multiple package features in parallel?

The best way to write markdown docs for multiple features in parallel is spawning doc-writer sub-agents. Each sub-agent generates an individual page based on the parsed source code, which are then assembled into a complete documentation set with updated metadata.

Do I need to manually write an overview and getting started guide if I auto-generate package docs?

No, you do not need to manually write an overview or getting started guide. The documentation generation skill automatically creates these sections alongside per-feature pages by analyzing the package's source code and architecture.