readme-writer
Provides structure and guidelines for writing module-level README files.
Install
mkdir -p .claude/skills/readme-writer && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/6698" && unzip -o skill.zip -d .claude/skills/readme-writer && rm skill.zipInstalls to .claude/skills/readme-writer
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Guidelines for writing module READMEs that explain how a module works to developers who need to use it or understand its internals. Use when documenting a module, package, or subsystem.Key capabilities
- →Structure documentation with overview, usage, and examples
- →Define domain-specific terminology in core concepts
- →Map module functionality to system-wide workflows
- →Standardize placement of documentation relative to code
How it works
Applies a predefined architectural template to the module folder, organizing content by operational flow and dependency usage.
Inputs & outputs
When to use readme-writer
- →Documenting a new utility module
- →Explaining module internals to team members
- →Standardizing documentation across a repo
About readme-writer
Enforces a consistent README structure including overview, usage context, and code examples. It ensures documentation is placed correctly within the project directory.
Guidelines for writing module READMEs that explain how a module works to developers who need to use it or understand its internals. Use when documenting a module, package, or subsystem.
When not to use it
- →For documenting minor helper functions that do not belong to a module
- →When project documentation is strictly managed via centralized wikis
Limitations
- →Cannot generate content about functionality without existing source analysis
- →Strict structure may feel rigid for non-utility modules
How it compares
It enforces structural consistency based on project-specific module organization, preventing unstructured documentation bloat.
Compared to similar skills
readme-writer side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| readme-writer (this skill) | 1 | 9mo | No flags | Beginner |
| architecture-decision-records | 54 | 6mo | Review | Beginner |
| meeting-minutes | 41 | 8mo | No flags | Beginner |
| docs-write | 22 | 7mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by AztecProtocol
View all by AztecProtocol →You might also like
architecture-decision-records
wshobson
Write and maintain Architecture Decision Records (ADRs) following best practices for technical decision documentation. Use when documenting significant technical decisions, reviewing past architectural choices, or establishing decision processes.
meeting-minutes
github
Generate concise, actionable meeting minutes for internal meetings. Includes metadata, attendees, agenda, decisions, action items (owner + due date), and follow-up steps.
docs-write
metabase
Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).
rust-docs-guidelines
RediSearch
Guidelines for writing Rust documentation
ml-paper-writing
davila7
Write publication-ready ML/AI papers for NeurIPS, ICML, ICLR, ACL, AAAI, COLM. Use when drafting papers from research repos, structuring arguments, verifying citations, or preparing camera-ready submissions. Includes LaTeX templates, reviewer guidelines, and citation verification workflows.
content-research-writer
ComposioHQ
Assists in writing high-quality content by conducting research, adding citations, improving hooks, iterating on outlines, and providing real-time feedback on each section. Transforms your writing process from solo effort to collaborative partnership.