doc-writer

Generate JSDoc/TSDoc comments, READMEs, and API documentation across codebases.

Updated Jan 11, 2026

Search Tags:#architecture #documentation #readme #API docs #JSDoc #style-guide #inline-comments

Ready to run

npx skills add https://github.com/masrurimz/amp-sisyphus --skill doc-writer-masrurimz

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/masrurimz/amp-sisyphus/tree/main/skills/doc-writer
Command: npx skills add https://github.com/masrurimz/amp-sisyphus --skill doc-writer-masrurimz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill writes consistent, accurate technical documentation across codebases, including JSDoc/TSDoc, READMEs, and API guides.

Core Features & Use Cases

JSDoc/TSDoc generation: Create inline documentation for functions, classes, and modules in-code.
Documentation suites: Produce README updates, API references, and architecture guides aligned to project style.
Use Case: Generate a complete documentation set for a new module, including code comments and user-facing docs.

Quick Start

Request documentation for a module by generating JSDoc comments, README content, and API docs following the project's style guidelines.

Frequently Asked Questions about doc-writer

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

FAQPage Schema

How do I generate JSDoc comments for an existing module?▼

Generate JSDoc comments by applying inline documentation standards to functions, classes, and modules. The skill reads existing code and writes consistent TSDoc or JSDoc comments aligned to the project's style guidelines.

What is the best way to write an architecture guide for a codebase?▼

Writing an architecture guide involves producing technical documentation that explains structural decisions across the codebase. The skill creates these guides alongside READMEs and API references to maintain documentation consistency.

Can I use this to update a README and API docs at the same time?▼

Yes, you can update a README and API docs simultaneously. The skill produces complete documentation suites, generating user-facing README content and API references together following project style guidelines.

Does this skill enforce a specific documentation style guide?▼

The skill enforces documentation style by applying consistency rules across generated content. It aligns JSDoc, TSDoc, and architecture guides to existing project style guidelines rather than imposing a rigid external standard.

When do I need to generate inline comments versus a full documentation suite?▼

Generate inline comments for individual functions, classes, and modules during active development. Produce a full documentation suite, including READMEs and API references, when finalizing a new module for release.