skills.rest
dralgorhythm
dralgorhythmCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation

Write structured Markdown documentation for software projects.

111|18|Updated Dec 17, 2025
Search Tags:#documentation#readme#guides#architecture-docs#API-docs
One-click install
npx skills add https://github.com/dralgorhythm/claude-agentic-framework --skill documentation-dralgorhythm
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/dralgorhythm/claude-agentic-framework/tree/main/.claude/skills/product/documentation
Command: npx skills add https://github.com/dralgorhythm/claude-agentic-framework --skill documentation-dralgorhythm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps produce README, API docs, and user guides with clear structure and guidance.

Core Features & Use Cases

  • Documentation Types: README, API docs, architecture docs, user guides.
  • Writing Principles: Know your audience, be concise, structure for scanning.
  • Use Case: Create a Quick Start guide for a new library.

Quick Start

Create a README with installation and quick start sections.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write a README that covers installation and quick start?▼

A README should structure installation steps clearly, then provide a quick start section with minimal setup needed to run the project. This Skill generates README files with these sections organized for scanning, including code blocks and step-by-step instructions so users get running fast.

What should API documentation include?▼

API documentation needs endpoint descriptions, request/response formats, data models, and usage examples. This Skill produces structured API docs with tables for endpoints, code blocks for examples, and clear parameter explanations to help developers integrate quickly.

How do I document software architecture decisions?▼

Architecture documentation captures design rationale, system components, and trade-offs. This Skill writes architecture docs using ADR (Architecture Decision Record) format with structured sections, diagrams references, and reasoning that explain why choices were made.

Can I create user guides for different audience levels?▼

Yes. User guides benefit from audience-aware writing that matches reader expertise. This Skill tailors guides by audience—basic setup for beginners, advanced troubleshooting for experienced users—using concise language and scannable structure for each group.

What's the best way to organize documentation for a new library?▼

Organize by user journey: what the library does, how to install it, quick start example, full API reference, and troubleshooting. This Skill generates complete, structured documentation in Markdown with proper headings, code blocks, and tables that guides users from discovery to mastery.

Related Skills

BaryoDevBaryoDev

documentation

Generate READMEs, API specs, inline comments, and architecture diagrams.

Official
Intermediate
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
t-stringst-strings

Backend Migrations

Standardize versioned database migration scripts with rollback support and execution logs.

Official
Basic
erlebacherlebach

technical-blog-writing

Compose developer-focused technical blog posts with structured outlines and runnable code blocks.

Community
Advanced