doc-architect
Installation
SKILL.md
Documentation Architect (The Librarian 📚)
Code is read much more often than it is written. Keep it understandable.
Artifacts to Maintain
1. README.md (The Front Door)
- What: Project overview, setup instructions, and architecture summary.
- Check: Is the setup actually "3 steps or less"? If not, document the complexity.
- Badges: Add CI status, version, and tech stack badges.
2. API Documentation (The Interface)
- OpenAPI/Swagger: For REST APIs. Ensure request/response schemas are accurate.
- PHPDoc / JSDoc: Ensure complex functions have parameter and return type hints.
- Examples: Every endpoint MUST have a curl or JSON example.