skills.rest
miles990
miles990COMMUNITY
Explore all skills by this author →
GitHub

documentation

Generate templates for READMEs, API docs, ADRs, and runbooks.

20|5|Updated Jan 5, 2026
Search Tags:#changelog#documentation#technical writing#adr#readme#api docs
One-click install
npx skills add https://github.com/miles990/claude-software-skills --skill documentation-miles990
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/miles990/claude-software-skills/tree/main/software-engineering/documentation
Command: npx skills add https://github.com/miles990/claude-software-skills --skill documentation-miles990

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating clear, comprehensive, and maintainable documentation for software projects, ensuring knowledge is accessible and onboarding is smooth.

Core Features & Use Cases

  • Documentation Standards: Provides best practices for various documentation types like READMEs, API docs, and ADRs.
  • Template Generation: Offers templates for common documentation artifacts such as READMEs, Changelogs, and Architecture Decision Records.
  • Use Case: A new developer joins a project and needs to understand its architecture. They can refer to the ADRs generated and maintained using this Skill to grasp design decisions quickly.

Quick Start

Generate a README file for a new project using the provided template.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write effective API documentation and READMEs for a software project?▼

Effective API documentation and READMEs require structured templates and adherence to technical writing best practices. This Skill provides standardized formats for these artifacts, ensuring your project knowledge is accessible and onboarding is smooth for new developers.

What is an Architecture Decision Record and when should I use one?▼

An Architecture Decision Record (ADR) captures critical design decisions within a software project. You should use ADRs to document architectural context and rationale, which facilitates knowledge sharing and improves project maintainability across the development team.

What is the best way to generate a changelog for my codebase?▼

The best way to generate a changelog is by applying structured technical writing standards to track project changes. This Skill offers specific templates for changelog generation, ensuring your project history remains clear, comprehensive, and maintainable.

Can I use this for code documentation standards like JSDoc and TSDoc?▼

Yes, this Skill supports code documentation by providing best practices for JSDoc and TSDoc. It helps structure your inline documentation artifacts, ensuring knowledge sharing and project maintainability through standardized technical writing.

Does this Skill provide templates for runbooks and technical writing?▼

Yes, this Skill provides template generation for runbooks alongside READMEs, Changelogs, and ADRs. These templates establish technical writing standards, allowing you to quickly create structured documentation artifacts for various operational scenarios.

Related Skills

Explore More Software Engineering Skills→
Pixel-Process-UGPixel-Process-UG
1

tech-docs-generator

Generates technical documentation from source code, including API references and architecture overviews.

Official
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
miounet11miounet11

Doc Generator

Generate and improve code documentation across JSDoc, README, and API specs.

Community
Intermediate
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced