comm-doc-writer

Generate standardized documentation templates for READMEs, API docs, ADRs, changelogs, and runbooks.

1|Updated Sep 12, 2025

Search Tags:#changelog #documentation #adr #readme #api-docs #writing-principles #docs-patterns

Ready to run

npx skills add https://github.com/JimmyTranDev/dotfiles --skill comm-doc-writer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: comm-doc-writer
Source: https://github.com/JimmyTranDev/dotfiles/tree/main/src/opencode/skills/comm-doc-writer
Command: npx skills add https://github.com/JimmyTranDev/dotfiles --skill comm-doc-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often lacks consistency across READMEs, API docs, ADRs, and changelogs, causing onboarding friction and maintenance overhead.

Core Features & Use Cases

Standardized templates for README, API docs, ADRs, Changelog, Inline code docs, Onboarding guides, Runbooks
Completeness checklists and best-practice patterns to ensure clarity, structure, and versioned history
Example patterns and recommended structures for audience-focused documentation and quick-start guides

Quick Start

Provide a ready-to-use template pack and fill-in-the-blank prompts to generate a complete documentation suite for a new project.

Frequently Asked Questions about comm-doc-writer

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

FAQPage Schema

How do I standardize project documentation across READMEs, API docs, and changelogs?▼

Standardize project documentation by using a frontmatter-driven template system that generates consistent structures for READMEs, API docs, and changelogs. This approach enforces clearly defined sections, completeness checklists, and reusable patterns to eliminate onboarding friction and maintenance overhead.

What is the best way to write an Architecture Decision Record for a new software project?▼

Writing an Architecture Decision Record (ADR) is best handled through standardized documentation templates that enforce versioned history and best-practice patterns. ADR templates ensure clarity and structure for technical decisions, improving long-term maintenance and knowledge transfer across teams.

How do I generate a complete documentation suite for onboarding new developers?▼

Generate a complete documentation suite for onboarding by applying fill-in-the-blank prompts to a ready-to-use template pack. This creates audience-focused onboarding guides, runbooks, and quick-start guides that standardize the knowledge transfer process and reduce setup friction.

Can I use standardized docs patterns for existing software projects and product lines?▼

Standardized docs patterns can be applied across existing software projects, teams, and product lines. The template system scales to organize and generate documentation for varied contexts, ensuring consistent structure and completeness checklists regardless of project size.

Why does my API documentation lack consistency across different software teams?▼

API documentation lacks consistency when teams do not use standardized writing principles and documentation patterns. Implementing a frontmatter-driven template system with completeness checklists enforces clearly defined sections, resolving structural misalignment and improving maintainability.

memorysaver

content-documenter

Generate structured Markdown documentation from analyzed media content.

Community

Advanced

dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community

Intermediate

sunholo-data

AILANG Release Manager

Automates end-to-end AILANG release management including pre-release checks, version bumps, changelog updates, git tagging, CI/CD verification, and release broadcasting.

Official

Intermediate