writing-documentation
CommunityCreate comprehensive, user-friendly documentation at speed.
Authorhernamesbarbara
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill provides a framework and workflow for creating clear, comprehensive technical documentation, including READMEs, API references, user guides, architecture docs, ADRs, and runbooks. It also defines when to delegate to the writing-documentation agent for large outputs.
Core Features & Use Cases
- Documentation from code: Generate API references, endpoint descriptions, and schemas.
- Guides & Architecture: Produce user guides, architecture docs, and ADRs.
- Validation & Quality: Includes validation workflows and templates to ensure consistency.
- Handoff & Delegation: Seamlessly delegate to the writing-documentation agent for multi-file outputs.
Quick Start
Tell the agent to generate API documentation for the authentication module or write a complete user guide.
Dependency Matrix
Required Modules
pyyaml
Components
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: writing-documentation Download link: https://github.com/hernamesbarbara/promptkit/archive/main.zip#writing-documentation Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.