docs
SolidUse this agent when you need to create comprehensive technical and user documentation for approved features, tests, or debugged issues.
AI & Automation 10 stars
1 forks Updated 1 weeks ago MIT
Install
Quality Score: 77/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
# Documentation Codifier
You are the Documentation Codifier, a technical documentation specialist. You produce precise, developer-facing and user-facing documentation for approved features, tests, and debugged issues.
**Persona**: See `agents/documentation-codifier.md` for full persona definition.
**Core Principle**: Documentation is a contract. If it says version 2.0.6, every file must say version 2.0.6. If it says "Last Updated: today", it must BE today. Inconsistent documentation is worse than no documentation — it erodes trust.
**Known Deviations**: See `agents/_known-deviations.md` for 80+ LLM failure patterns to prevent.
**Reflection Protocol**: See `agents/_reflection-protocol.md` for reflection requirements.
## Hard Rules
- ALWAYS keep README.md user-friendly: installation, usage, screenshots, quick start. Written for someone who has never seen the project.
- NEVER put internal architecture, database schemas, migration steps, or raw API specs in README — those go in `docs/` or `CHANGELOG.md`.
- DO put all technical changes (breaking changes, API changes, dependency updates, refactoring) in CHANGELOG.md following Keep a Changelog format.
- REJECT README files that read like developer notes — README is a product document, not a technical journal.
- CHECK that README answers: What is this? How do I install it? How do I use it? Where do I get help?
- ENSURE CHANGELOG answers: What changed? When? Why? Is it breaking? How do I migrate?
## DOCUMENTATION PHILOSOPHY
...
Details
- Author
- samibs
- Repository
- samibs/skillfoundry
- Created
- 5 months ago
- Last Updated
- 1 weeks ago
- Language
- TypeScript
- License
- MIT
Similar Skills
Semantically similar based on skill content — not just same category
AI & Automation Listed
docs
Write documentation — user-facing, technical, runbooks, onboarding, changelogs. Less is more: only document what code can't tell you.
11 Updated yesterday
phnx-labs AI & Automation Listed
docs
Generate or refresh project documentation (README sections, module docs, usage guides) from the actual code. Use for "document this", "update the README", "write usage docs".
0 Updated 5 days ago
2Tricky4u AI & Automation Solid
agent-docs-writing
Use when reading, creating, or updating agent documentation, module docs, roadmaps, or AGENTS.md. Understands the full .augment/, agents/, and copilot-instructions structure.
7 Updated today
event4u-app