csa-doc-writing
CommunityCraft clear docs that communicate ideas fast.
AuthorRyderFreeman4Logos
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Clear, practical documentation guidance for APIs, README files, architecture decisions, and changelogs to improve consistency, onboarding, and maintenance.
Core Features & Use Cases
- Code documentation guidelines for Rust and public APIs, including doc comments and examples.
- README structure guidance to standardize project introductions, usage, and contribution notes.
- ADR and CHANGELOG formats to capture decisions and release notes in a deterministic, readable form.
- Documentation workflow outlining Analysis, Synthesis, and Write steps to produce high-quality docs.
- Checklist-based quality assurance to ensure documentation accuracy and completeness.
Quick Start
Follow the structured workflow to document a new module: analyze the code, draft the API docs and ADRs, and publish a changelog.
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: csa-doc-writing Download link: https://github.com/RyderFreeman4Logos/cli-sub-agent/archive/main.zip#csa-doc-writing 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 510,000+ vetted skills library on demand.