claude-autopm 1.27.0 → 1.29.0

package/autopm/.claude/templates/prds/documentation.md

@@ -0,0 +1,439 @@
+---
+id: {{id}}
+title: {{title}}
+type: prd
+status: draft
+priority: {{priority}}
+created: {{timestamp}}
+author: {{author}}
+timeline: {{timeline}}
+doc_type: {{doc_type}}
+---
+
+# PRD: Documentation - {{title}}
+
+## Executive Summary
+
+Create/update documentation for {{doc_purpose}}.
+
+**Documentation Type**: {{doc_type}}
+**Target Audience**: {{target_audience}}
+**Delivery Format**: {{delivery_format}}
+
+## Documentation Overview
+
+### Purpose
+{{purpose}}
+
+### Scope
+{{scope}}
+
+### Target Audience
+
+**Primary Audience**: {{primary_audience}}
+- Technical Level: {{technical_level}}
+- Prior Knowledge: {{prior_knowledge}}
+- Use Case: {{primary_use_case}}
+
+{{#if secondary_audience}}
+**Secondary Audience**: {{secondary_audience}}
+- Technical Level: {{secondary_technical_level}}
+- Prior Knowledge: {{secondary_prior_knowledge}}
+- Use Case: {{secondary_use_case}}
+{{/if}}
+
+## Documentation Type
+
+**Type**: {{doc_type}}
+
+- [ ] **API Documentation** - REST/GraphQL API reference
+- [ ] **User Guide** - End-user instructions
+- [ ] **Developer Guide** - Technical implementation guide
+- [ ] **Architecture Documentation** - System design and architecture
+- [ ] **Runbook** - Operational procedures
+- [ ] **Tutorial** - Step-by-step learning guide
+- [ ] **Reference Documentation** - Technical specifications
+- [ ] **Troubleshooting Guide** - Problem resolution
+- [ ] **Release Notes** - Version changes and updates
+- [ ] **Migration Guide** - Upgrade/migration instructions
+
+## Current State Analysis
+
+### Existing Documentation
+{{#if existing_docs}}
+| Document | Status | Issues | Action |
+|----------|--------|--------|--------|
+| {{doc_1}} | {{status_1}} | {{issues_1}} | {{action_1}} |
+| {{doc_2}} | {{status_2}} | {{issues_2}} | {{action_2}} |
+{{/if}}
+
+### Documentation Gaps
+{{#if documentation_gaps}}
+{{#each documentation_gaps}}
+- {{gap}}: {{impact}}
+{{/each}}
+{{/if}}
+
+### User Feedback
+{{#if user_feedback}}
+{{#each user_feedback}}
+- {{feedback}} (Source: {{source}}, Date: {{date}})
+{{/each}}
+{{/if}}
+
+## Content Outline
+
+### Document Structure
+
+{{#if content_sections}}
+{{#each content_sections}}
+**{{section_number}}. {{section_title}}**
+- {{section_description}}
+- Audience: {{section_audience}}
+- Estimated Pages: {{section_pages}}
+{{/each}}
+{{/if}}
+
+### Detailed Content Plan
+
+#### Introduction
+- [ ] Overview and purpose
+- [ ] Target audience
+- [ ] Prerequisites
+- [ ] Document conventions
+- [ ] Related documentation
+
+#### Main Content
+{{main_content_outline}}
+
+#### Appendix
+- [ ] Glossary of terms
+- [ ] References and links
+- [ ] FAQ
+- [ ] Troubleshooting
+- [ ] Code examples (if applicable)
+
+## Writing Standards (2025 Best Practices)
+
+### Style Guide
+- **Voice**: {{voice_style}} (Active/Passive)
+- **Tone**: {{tone}} (Formal/Conversational/Technical)
+- **Person**: {{person}} (First/Second/Third)
+- **Tense**: {{tense}} (Present/Past)
+
+### Content Principles
+- [ ] **Clarity**: Simple language, short sentences
+- [ ] **Conciseness**: No unnecessary words
+- [ ] **Consistency**: Uniform terminology and structure
+- [ ] **Completeness**: All necessary information included
+- [ ] **Correctness**: Technically accurate, verified
+
+### Accessibility (WCAG 2.1 AA)
+- [ ] Plain language (reading level: {{reading_level}})
+- [ ] Descriptive headings and structure
+- [ ] Alt text for all images
+- [ ] Accessible tables and lists
+- [ ] Color contrast (4.5:1 minimum)
+- [ ] Keyboard navigation for interactive docs
+
+### SEO Optimization (if web-based)
+- [ ] Keyword research completed
+- [ ] Meta descriptions written
+- [ ] Headings optimized (H1, H2, H3)
+- [ ] Internal linking strategy
+- [ ] Image optimization (alt text, file names)
+
+## Technical Requirements
+
+### Documentation Platform
+- **Primary Platform**: {{platform}} (GitBook/Confluence/ReadTheDocs/Docusaurus)
+- **Format**: {{format}} (Markdown/reStructuredText/HTML)
+- **Version Control**: {{version_control}} (Git/SVN)
+- **Hosting**: {{hosting}} (GitHub Pages/Netlify/Custom)
+
+### Tools & Stack
+{{#if tools}}
+{{#each tools}}
+- **{{tool_name}}**: {{tool_purpose}}
+{{/each}}
+{{/if}}
+
+### Documentation as Code
+- [ ] Markdown source files
+- [ ] Version controlled (Git)
+- [ ] Automated build pipeline
+- [ ] Preview environments
+- [ ] Automated testing (link checking, spell check)
+
+### Interactive Elements
+{{#if interactive_elements}}
+- [ ] Code playgrounds (CodeSandbox/JSFiddle)
+- [ ] API explorers (Swagger UI/Postman)
+- [ ] Interactive diagrams (Mermaid/PlantUML)
+- [ ] Video tutorials ({{video_platform}})
+- [ ] Live examples ({{example_platform}})
+{{/if}}
+
+## Visual Elements
+
+### Diagrams & Illustrations
+{{#if diagrams}}
+{{#each diagrams}}
+- **{{diagram_type}}**: {{diagram_purpose}}
+  - Tool: {{diagram_tool}}
+  - Estimated: {{diagram_count}} diagrams
+{{/each}}
+{{/if}}
+
+### Screenshots & Media
+- [ ] Screenshots ({{screenshot_count}} estimated)
+- [ ] Screencasts ({{screencast_count}} estimated)
+- [ ] Infographics ({{infographic_count}} estimated)
+- [ ] Code snippets (syntax highlighted)
+
+### Design Consistency
+- [ ] Branded templates
+- [ ] Consistent color scheme
+- [ ] Standard icons and symbols
+- [ ] Typography guidelines
+- [ ] White space standards
+
+## Code Examples
+
+### Example Strategy
+- [ ] Minimal reproducible examples
+- [ ] Multiple languages (if applicable): {{languages}}
+- [ ] Progressive complexity (basic → advanced)
+- [ ] Real-world use cases
+- [ ] Copy-paste ready
+
+### Code Quality
+- [ ] Syntax highlighted
+- [ ] Well-commented
+- [ ] Error handling included
+- [ ] Best practices demonstrated
+- [ ] Tested and verified
+
+### Example Repository
+{{#if example_repo}}
+- Repository: {{example_repo_url}}
+- Languages: {{example_languages}}
+- Setup instructions: {{example_setup}}
+{{/if}}
+
+## Review & Validation
+
+### Review Process
+
+**Technical Review**:
+- [ ] Subject matter expert (SME) review
+- [ ] Technical accuracy verification
+- [ ] Code example validation
+- [ ] Security review (if applicable)
+
+**Editorial Review**:
+- [ ] Grammar and spelling
+- [ ] Style guide compliance
+- [ ] Consistency check
+- [ ] Readability assessment (Flesch-Kincaid score)
+
+**User Review**:
+- [ ] Peer review (target audience)
+- [ ] Usability testing
+- [ ] Feedback incorporation
+- [ ] Final approval
+
+### Quality Checklist
+
+- [ ] All sections complete
+- [ ] Links verified (no 404s)
+- [ ] Images load correctly
+- [ ] Code examples tested
+- [ ] Cross-browser compatible
+- [ ] Mobile responsive
+- [ ] Search functionality works
+- [ ] Navigation intuitive
+
+### Testing Criteria
+- **Readability**: Flesch-Kincaid Grade {{target_grade}}
+- **Completeness**: 100% of outlined content
+- **Accuracy**: Zero technical errors
+- **Accessibility**: WCAG 2.1 AA compliant
+- **Performance**: Page load < 2s
+
+## Success Metrics (SMART Goals)
+
+- **Adoption**: {{adoption_target}}% of users access docs within {{timeframe}}
+- **Engagement**: {{engagement_target}} avg. time on page
+- **Satisfaction**: {{satisfaction_target}}/5 user rating
+- **Helpfulness**: {{helpfulness_target}}% "found helpful"
+- **Support Reduction**: {{support_reduction_target}}% fewer support tickets
+- **Search Success**: {{search_success_target}}% find answer via search
+
+## Analytics & Measurement
+
+### Tracking Metrics
+- [ ] Page views and unique visitors
+- [ ] Time on page / bounce rate
+- [ ] Search queries (internal search)
+- [ ] Download counts (PDFs, code samples)
+- [ ] Video engagement (completion rate)
+- [ ] Link clicks (external references)
+
+### Feedback Collection
+- [ ] Rating widget (helpful/not helpful)
+- [ ] Comment section
+- [ ] Feedback form
+- [ ] User surveys
+- [ ] Support ticket correlation
+
+### Continuous Improvement
+- [ ] Monthly analytics review
+- [ ] Quarterly content audit
+- [ ] User feedback incorporation
+- [ ] A/B testing (headlines, structure)
+- [ ] Search optimization
+
+## Implementation Plan
+
+### Phase 1: Planning & Research (Week 1)
+- [ ] Audience analysis
+- [ ] Content audit
+- [ ] Outline creation
+- [ ] Style guide finalization
+- [ ] Tool selection and setup
+
+### Phase 2: Content Creation (Week 2-3)
+- [ ] Write first draft (all sections)
+- [ ] Create diagrams and visuals
+- [ ] Develop code examples
+- [ ] Record videos (if applicable)
+- [ ] Build interactive elements
+
+### Phase 3: Review & Refinement (Week 4)
+- [ ] Technical review
+- [ ] Editorial review
+- [ ] User review / testing
+- [ ] Feedback incorporation
+- [ ] Final polish
+
+### Phase 4: Publication (Week 5)
+- [ ] Platform setup / migration
+- [ ] Content upload
+- [ ] SEO optimization
+- [ ] Link verification
+- [ ] Soft launch (beta users)
+
+### Phase 5: Launch & Maintenance (Week 6+)
+- [ ] Official launch
+- [ ] User communication
+- [ ] Analytics setup
+- [ ] Feedback monitoring
+- [ ] Regular updates (schedule: {{update_schedule}})
+
+## Maintenance Strategy
+
+### Update Triggers
+- Product releases (new features)
+- Bug fixes (corrections needed)
+- User feedback (confusion points)
+- Quarterly reviews (scheduled)
+- Technology changes (platform updates)
+
+### Version Control
+- [ ] Documentation versioning (matches product versions)
+- [ ] Changelog maintained
+- [ ] Archive old versions
+- [ ] Deprecation notices
+- [ ] Migration guides (version to version)
+
+### Ownership
+- **Primary Owner**: {{primary_owner}}
+- **Contributors**: {{contributors}}
+- **Reviewers**: {{reviewers}}
+- **Update Frequency**: {{update_frequency}}
+
+## Localization (i18n)
+
+{{#if localization_needed}}
+### Target Languages
+{{#each target_languages}}
+- {{language}}: {{priority}} priority, {{target_date}} target
+{{/each}}
+
+### Translation Process
+- [ ] Extract translatable content
+- [ ] Professional translation service
+- [ ] Technical term glossary
+- [ ] Review by native speakers
+- [ ] Cultural adaptation
+- [ ] Localized examples
+
+### Maintenance
+- [ ] Translation management system
+- [ ] Sync updates across languages
+- [ ] Quality assurance per language
+{{/if}}
+
+## Risk Assessment
+
+### Documentation Risks
+
+| Risk | Impact | Probability | Mitigation |
+|------|--------|-------------|------------|
+| Outdated content | High | High | Regular audits, automated checks |
+| Technical inaccuracy | Critical | Medium | SME review, testing |
+| Poor discoverability | High | Medium | SEO, search optimization |
+| Low user adoption | High | Medium | User testing, feedback loops |
+| Broken links/examples | Medium | High | Automated testing, CI/CD |
+
+## Communication Plan
+
+### Launch Announcement
+- **Channels**: {{announcement_channels}}
+- **Message**: {{announcement_message}}
+- **Target Date**: {{launch_date}}
+
+### Ongoing Communication
+- [ ] Newsletter updates
+- [ ] Social media posts
+- [ ] In-app notifications
+- [ ] Support team briefing
+- [ ] Developer community outreach
+
+## Appendix
+
+### Related Documentation
+{{#if related_docs}}
+{{#each related_docs}}
+- [{{doc_title}}]({{doc_url}}) - {{doc_description}}
+{{/each}}
+{{/if}}
+
+### References & Resources
+- [Write the Docs Best Practices](https://www.writethedocs.org/guide/)
+- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
+- [Google Developer Documentation Style Guide](https://developers.google.com/style)
+- [Documentation as Code](https://www.writethedocs.org/guide/docs-as-code/)
+- [WCAG 2.1 Guidelines](https://www.w3.org/TR/WCAG21/)
+
+### Templates & Assets
+- Style guide: {{style_guide_url}}
+- Document template: {{template_url}}
+- Diagram templates: {{diagram_template_url}}
+- Code snippet library: {{snippet_library_url}}
+
+### Glossary
+{{#if glossary_terms}}
+{{#each glossary_terms}}
+- **{{term}}**: {{definition}}
+{{/each}}
+{{/if}}
+
+### Changelog
+- {{timestamp}}: Initial documentation PRD created by {{author}}
+
+---
+
+*Documentation PRD - Generated from template: documentation*
+*Template follows 2025 best practices: Docs-as-Code, WCAG 2.1 AA, SEO optimization, analytics-driven improvement*