documentation-writer-protocol
CommunityStandardized docs that guide every decision.
Authormajedsiefalnasr
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This protocol standardizes and streamlines the creation of Architecture Decision Records (ADRs) and API endpoint documentation, ensuring consistent governance across projects and teams.
Core Features & Use Cases
- Immutability: ADRs are immutable once accepted, and new ADRs supersede older ones to capture evolving decisions.
- Multi-format docs: Guidance covers ADRs, API docs, and root README documentation for major directories with bilingual support (Arabic and English where applicable).
- Automation-friendly: Designed to feed OpenAPI specs and code comments into generated docs while preserving human-readable context.
- Quick-start workflows: Provides a simple, repeatable sequence to draft and review documentation for new components.
Quick Start
Draft ADRs and API documentation for a new component using this protocol.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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: documentation-writer-protocol Download link: https://github.com/majedsiefalnasr/bunyan-app-cursor/archive/main.zip#documentation-writer-protocol 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.