Provides guidance for creating and maintaining project documentation, including PRD, technical specifications, and user guides. Invoke when working on documentation-related tasks or when needing documentation structure advice.
name documentation description Provides guidance for creating and maintaining project documentation, including PRD, technical specifications, and user guides. Invoke when working on documentation-related tasks or when needing documentation structure advice. Documentation This skill provides comprehensive guidance for creating and maintaining documentation for the Family Tree App project. Documentation Structure docs/ ├── product-research/ # Product research documents ├── prd/ # Product requirements document ├── ui-design/ # UI/UX design documents ├── implementation/ # Technical implementation documents └── ai-tools/ # AI tools research and integration Key Documentation Types Product Research Market analysis User requirements Competitor analysis Market opportunities Product Requirements Document (PRD) Product overview Core features User flows UI design guidelines Technical requirements Data models Non-functional requirements UI/UX Design Design system Wireframes Mockups UI interaction design User testing reports Technical Implementation Backend implementation guide Frontend implementation guide API documentation Database schema Security considerations AI Tools Integration AI tools research Tool paradigm recommendations Integration guidelines Performance considerations Documentation Standards Formatting Markdown syntax Consistent heading hierarchy Clear and concise language Proper use of lists and tables Code blocks for technical content Content Guidelines Start with an overview Use clear, descriptive headings Include relevant diagrams and visuals Provide examples where appropriate Maintain consistency across documents Version Control Track documentation changes with Git Use meaningful commit messages Review and update documentation regularly Keep documentation in sync with code changes Documentation Tools Markdown editors Diagram tools (Mermaid, Draw.io) Documentation generators Version control systems Best Practices Document early and often Involve stakeholders in documentation review Keep documentation up to date Make documentation accessible Use templates for consistency Include code examples where relevant Document edge cases and limitations User Documentation Installation guides User manuals FAQs Troubleshooting guides Release notes Technical Documentation API reference Architecture diagrams Database schema Deployment guides Development setup Maintenance Regular documentation reviews Update documentation with new features Remove outdated information Improve documentation based on feedback Ensure documentation is searchable