documentation
Documentation
This skill provides documentation guidelines and standards.
See @REFERENCE.md for detailed documentation.
Quick Reference
- README: Installation, quick start, config, commands
- CHANGELOG: Keep a Changelog format
- ADR: Architecture Decision Records for major choices
- Code: Comments explain WHY, not WHAT
- API: OpenAPI/Swagger specs
More from thebeardedbearsas/claude-craft
kiss-dry-yagni
Principes KISS, DRY, YAGNI. Use when reviewing code quality or refactoring.
96solid-principles
SOLID principles for object-oriented design. Use when reviewing code quality, refactoring, designing classes or interfaces, or discussing architecture patterns.
23security
Security guidelines and OWASP Top 10. Use when reviewing security, implementing authentication or authorization, hardening code, or discussing vulnerabilities.
22testing
TDD/BDD testing principles. Use when writing tests, reviewing test coverage, setting up testing, or discussing test strategy and test architecture.
21workflow-analysis
Workflow d'Analyse Obligatoire. Use when working with workflow analysis.
20git-workflow
Git workflow and conventional commits. Use when working with git, branches, commits, pull requests, code review, or version control strategy.
18