skills.rest
d0d012
d0d012COMMUNITY
Explore all skills by this author →
GitHub

doc-writer

Generate and update Markdown documentation for APIs, READMEs, ADRs, and code comments.

9|Updated Apr 11, 2026
Search Tags:#documentation#markdown#adr#readme#api-docs#inline-comments#docs-maintenance
One-click install
npx skills add https://github.com/d0d012/claude-trim --skill doc-writer-d0d012
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/d0d012/claude-trim/tree/main/testdata/demo/plugins/dev-tools/skills/doc-writer
Command: npx skills add https://github.com/d0d012/claude-trim --skill doc-writer-d0d012

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is often out of date and hard to keep consistent across API docs, README files, ADRs, and inline code comments.

Core Features & Use Cases

  • Generate and update API documentation, README files, architecture decision records, and inline comments.
  • Maintain terminology consistency and ensure docs reflect recent code changes.
  • Use case: when onboarding a new module, automatically produce the API docs and update ADRs accordingly.

Quick Start

Create an API doc for the new module and refresh the project README.

Frequently Asked Questions about doc-writer

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

FAQPage Schema
How do I generate API documentation and READMEs for a new software module?▼

To generate API documentation and READMEs for a new module, you can automate the creation of structured Markdown sections and inline code comments. This ensures your technical docs reflect recent code changes and terminology consistency during onboarding.

What is the best way to maintain terminology consistency across architecture decision records?▼

Maintaining terminology consistency across architecture decision records involves automating documentation upkeep to align ADRs with recent refactors. This ensures structured Markdown sections accurately reflect the current state of your software project.

Can I automatically update inline code comments when refactoring a project?▼

Yes, you can automatically update inline code comments during a refactor by applying documentation automation. It integrates with existing docs workflows to ensure comments and API docs remain up-to-date without manual editing.

Does automated documentation generation work for software projects of varying sizes?▼

Automated documentation generation applies to software projects of varying sizes, from new modules to large refactors. It integrates with your existing docs workflows to maintain structured Markdown sections and API docs consistently.

How do I keep technical docs up to date with recent code changes?▼

Keeping technical docs up to date with recent code changes requires automating the upkeep of README files, ADRs, and inline comments. This ensures your technical documentation consistently reflects the latest refactors and module additions.

Related Skills

Explore More Content & Communication Skills→
luongnv89luongnv89
40.9k

api-documentation-generator

Generate API documentation from source code into Markdown and OpenAPI-style specs.

Community
Basic
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
wildbitcawildbitca
1

common-documentation

Standardize code comments, READMEs, and technical documentation practices.

Official
Basic
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic