documentation-templates
Documentation Templates Skill
Create clear, maintainable documentation for projects and code.
Resources
For full templates, see:
references/readme-template.md- Complete README templatereferences/api-docs-template.md- API documentation template
Core Principles
- Explain Why, Not What - Code shows what; docs explain why
- Keep it Updated - Outdated docs are worse than no docs
- Write for Humans - Clear, concise, jargon-free
- Progressive Disclosure - Start simple, provide details on demand
- Examples are King - Show, don't just tell
README Quick Structure
More from benshapyro/cadre-devkit-claude
frontend-design
Create distinctive, memorable user interfaces that avoid generic AI aesthetics. Use when designing UI/UX, planning visual direction, or building pages and layouts.
10error-handler
Provides battle-tested error handling patterns for TypeScript and Python. Use when implementing error handling, creating try/catch blocks, or handling exceptions.
5react-patterns
Modern React patterns for TypeScript applications including hooks, state management, and component composition. Use when building React components, managing state, or implementing React best practices.
4tailwind-conventions
Consistent Tailwind CSS patterns for React/Next.js applications. Use when styling components with Tailwind, adding responsive design, implementing dark mode, or organizing utility classes.
4product-discovery
Methodology for discovering and specifying new software products. Use when starting greenfield projects, exploring new ideas, or defining MVP scope.
4test-generator
Generates Jest or Pytest tests following Ben's testing standards. Use when creating tests, adding test coverage, writing unit tests, mocking dependencies, or when user mentions testing, test cases, Jest, Pytest, fixtures, assertions, or coverage.
3