> For the complete documentation index, see [llms.txt](https://jaegis.gitbook.io/JAEGIS/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jaegis.gitbook.io/JAEGIS/jaegis-method-v2.0-v2.1.1-jaegis-jaegis-method-jaegis-agent-templates-documentation-specification.md). # {{Project Name}} - Documentation Specification Template *Generated with JAEGIS Enhanced Validation & Research* \[\[LLM: VALIDATION CHECKPOINT - Review shared context from project requirements and validate all documentation needs. Integrate web research findings for current documentation standards and accessibility guidelines.]] ## Executive Summary \[\[LLM: RESEARCH INTEGRATION - Include current documentation best practices and validated specification frameworks. All documentation requirements must be supported by current industry standards and accessibility research.]] ## Project Documentation Requirements \[\[LLM: VALIDATION CHECKPOINT - All documentation requirements must be validated for completeness, accessibility, and current professional standards. Include research-backed documentation methodologies.]] **Spec Type**: Documentation Requirements & Planning Specification\ **Temporal Intelligence**: Automatic date adaptation using `new Date().toISOString().split('T')[0]` ## Documentation Specification Header Template ### 📋 **Documentation Project Overview** ```markdown # Documentation Specification - {project_name} **Project ID**: {project_id} **Project Name**: {project_name} **Documentation Type**: {documentation_type} **Specification Date**: {spec_date} **Generated**: {current_date} at {current_time} **Generated By**: DocQA (Documentation Quality Assurance Specialist) **Specification Version**: {spec_version} **Priority Level**: {priority_level} ## Executive Summary **Documentation Purpose**: {documentation_purpose} **Target Audiences**: {target_audiences} **Primary Use Cases**: {primary_use_cases} **Quality Standards**: {quality_standards} **Delivery Timeline**: {delivery_timeline} ### 🎯 **Key Documentation Metrics** - **Content Complexity**: {content_complexity}/10 - **Technical Depth**: {technical_depth}/10 - **User Experience Priority**: {ux_priority}/10 - **Maintenance Requirements**: {maintenance_requirements}/10 - **Quality Assurance Level**: {qa_level}/10 - **Accessibility Compliance**: {accessibility_compliance} - **Performance Requirements**: {performance_requirements} ``` ## Audience Analysis & Requirements Template ### 👥 **Target Audience Specification** ```markdown ## Target Audience Analysis & Requirements ### 📈 **Primary Audience Profiles** #### **Primary Audience: {primary_audience_type}** - **Audience Type**: {primary_audience_type} - **Technical Proficiency**: {technical_proficiency} - **Domain Expertise**: {domain_expertise} - **Usage Context**: {usage_context} - **Information Needs**: {information_needs} - **Task Objectives**: {task_objectives} - **Success Criteria**: {success_criteria} - **Preferred Formats**: {preferred_formats} #### **Secondary Audience: {secondary_audience_type}** - **Audience Type**: {secondary_audience_type} - **Technical Proficiency**: {secondary_technical_proficiency} - **Domain Expertise**: {secondary_domain_expertise} - **Usage Context**: {secondary_usage_context} - **Information Needs**: {secondary_information_needs} - **Task Objectives**: {secondary_task_objectives} - **Success Criteria**: {secondary_success_criteria} - **Preferred Formats**: {secondary_preferred_formats} ### 📊 **Audience Requirements Matrix** | Audience Type | Technical Level | Content Depth | Format Preference | Update Frequency | Quality Priority | |---------------|----------------|---------------|-------------------|------------------|------------------| | {audience_1} | {tech_level_1} | {depth_1} | {format_1} | {frequency_1} | {priority_1} | | {audience_2} | {tech_level_2} | {depth_2} | {format_2} | {frequency_2} | {priority_2} | | {audience_3} | {tech_level_3} | {depth_3} | {format_3} | {frequency_3} | {priority_3} | ### 🎯 **User Journey Mapping** #### **User Journey: {primary_user_journey}** - **Entry Point**: {entry_point} - **Information Seeking**: {information_seeking_behavior} - **Task Execution**: {task_execution_process} - **Problem Resolution**: {problem_resolution_approach} - **Success Validation**: {success_validation_criteria} - **Exit Criteria**: {exit_criteria} #### **Content Consumption Patterns** - **Reading Patterns**: {reading_patterns} - **Navigation Preferences**: {navigation_preferences} - **Search Behavior**: {search_behavior} - **Reference Usage**: {reference_usage} - **Feedback Patterns**: {feedback_patterns} ``` ## Content Strategy & Structure Template ### 📚 **Content Architecture Specification** ```markdown ## Content Strategy & Information Architecture ### 🏗️ **Information Architecture Design** #### **Content Hierarchy Structure** ``` {content\_hierarchy} Primary Content Categories: {primary\_categories} ├── {category\_1}: {category\_1\_description} │ ├── {subcategory\_1\_1}: {subcategory\_1\_1\_description} │ ├── {subcategory\_1\_2}: {subcategory\_1\_2\_description} │ └── {subcategory\_1\_3}: {subcategory\_1\_3\_description} ├── {category\_2}: {category\_2\_description} │ ├── {subcategory\_2\_1}: {subcategory\_2\_1\_description} │ ├── {subcategory\_2\_2}: {subcategory\_2\_2\_description} │ └── {subcategory\_2\_3}: {subcategory\_2\_3\_description} └── {category\_3}: {category\_3\_description} ├── {subcategory\_3\_1}: {subcategory\_3\_1\_description} ├── {subcategory\_3\_2}: {subcategory\_3\_2\_description} └── {subcategory\_3\_3}: {subcategory\_3\_3\_description} ``` #### **Content Type Specifications** - **User Guides**: {user_guide_specifications} - **Technical References**: {technical_reference_specifications} - **API Documentation**: {api_documentation_specifications} - **Tutorials & Examples**: {tutorial_specifications} - **Troubleshooting Guides**: {troubleshooting_specifications} - **Architecture Documentation**: {architecture_specifications} - **Administrative Procedures**: {admin_procedure_specifications} #### **Content Relationship Mapping** - **Cross-Reference Strategy**: {cross_reference_strategy} - **Linking Patterns**: {linking_patterns} - **Content Dependencies**: {content_dependencies} - **Update Relationships**: {update_relationships} - **Version Synchronization**: {version_synchronization} ### 📝 **Content Creation Standards** | Content Type | Minimum Length | Quality Standard | Review Process | Update Frequency | |--------------|----------------|------------------|----------------|------------------| | User Guides | {user_guide_length} | {user_guide_quality} | {user_guide_review} | {user_guide_frequency} | | API Documentation | {api_doc_length} | {api_doc_quality} | {api_doc_review} | {api_doc_frequency} | | Technical References | {tech_ref_length} | {tech_ref_quality} | {tech_ref_review} | {tech_ref_frequency} | | Tutorials | {tutorial_length} | {tutorial_quality} | {tutorial_review} | {tutorial_frequency} | | Troubleshooting | {troubleshoot_length} | {troubleshoot_quality} | {troubleshoot_review} | {troubleshoot_frequency} | ``` ## Quality Standards & Compliance Template ### ✅ **Quality Assurance Framework** ```markdown ## Quality Standards & Compliance Requirements ### 🎯 **Quality Standards Definition** #### **Content Quality Standards** - **Technical Accuracy**: {technical_accuracy_standard} - **Information Currency**: {information_currency_standard} - **Content Completeness**: {content_completeness_standard} - **Language Clarity**: {language_clarity_standard} - **Style Consistency**: {style_consistency_standard} - **Visual Quality**: {visual_quality_standard} - **User Experience**: {user_experience_standard} #### **Technical Compliance Requirements** - **Accessibility Standards**: {accessibility_standards} - **Performance Requirements**: {performance_requirements} - **Security Compliance**: {security_compliance} - **SEO Optimization**: {seo_optimization} - **Mobile Responsiveness**: {mobile_responsiveness} - **Cross-Browser Compatibility**: {browser_compatibility} - **Link Integrity**: {link_integrity_requirements} #### **Quality Validation Procedures** - **Content Review Process**: {content_review_process} - **Technical Validation**: {technical_validation_process} - **User Testing Requirements**: {user_testing_requirements} - **Accessibility Testing**: {accessibility_testing_process} - **Performance Testing**: {performance_testing_process} - **Link Validation**: {link_validation_process} - **Quality Scoring**: {quality_scoring_methodology} ### 📊 **Quality Metrics & Measurement** | Quality Dimension | Measurement Method | Target Score | Validation Frequency | Improvement Process | |-------------------|-------------------|--------------|---------------------|-------------------| | Technical Accuracy | {accuracy_measurement} | {accuracy_target} | {accuracy_frequency} | {accuracy_improvement} | | User Satisfaction | {satisfaction_measurement} | {satisfaction_target} | {satisfaction_frequency} | {satisfaction_improvement} | | Accessibility | {accessibility_measurement} | {accessibility_target} | {accessibility_frequency} | {accessibility_improvement} | | Performance | {performance_measurement} | {performance_target} | {performance_frequency} | {performance_improvement} | | Completeness | {completeness_measurement} | {completeness_target} | {completeness_frequency} | {completeness_improvement} | ### 🔒 **Compliance & Regulatory Requirements** #### **Regulatory Compliance Framework** - **Industry Standards**: {industry_standards} - **Regulatory Requirements**: {regulatory_requirements} - **Compliance Validation**: {compliance_validation} - **Audit Procedures**: {audit_procedures} - **Risk Management**: {risk_management} - **Legal Review**: {legal_review_requirements} - **Privacy Compliance**: {privacy_compliance} ``` ## Implementation Planning & Resource Allocation Template ### 📅 **Project Timeline & Milestones** ```markdown ## Implementation Planning & Resource Management ### 🚀 **Development Timeline & Phases** #### **Phase 1: Planning & Analysis** ({phase_1_duration}) - **Objectives**: {phase_1_objectives} - **Key Deliverables**: {phase_1_deliverables} - **Success Criteria**: {phase_1_success_criteria} - **Resource Requirements**: {phase_1_resources} - **Risk Factors**: {phase_1_risks} - **Quality Gates**: {phase_1_quality_gates} #### **Phase 2: Content Creation** ({phase_2_duration}) - **Objectives**: {phase_2_objectives} - **Key Deliverables**: {phase_2_deliverables} - **Success Criteria**: {phase_2_success_criteria} - **Resource Requirements**: {phase_2_resources} - **Risk Factors**: {phase_2_risks} - **Quality Gates**: {phase_2_quality_gates} #### **Phase 3: Quality Assurance** ({phase_3_duration}) - **Objectives**: {phase_3_objectives} - **Key Deliverables**: {phase_3_deliverables} - **Success Criteria**: {phase_3_success_criteria} - **Resource Requirements**: {phase_3_resources} - **Risk Factors**: {phase_3_risks} - **Quality Gates**: {phase_3_quality_gates} #### **Phase 4: Deployment & Launch** ({phase_4_duration}) - **Objectives**: {phase_4_objectives} - **Key Deliverables**: {phase_4_deliverables} - **Success Criteria**: {phase_4_success_criteria} - **Resource Requirements**: {phase_4_resources} - **Risk Factors**: {phase_4_risks} - **Quality Gates**: {phase_4_quality_gates} ### 📊 **Resource Allocation & Team Structure** | Role | Responsibility | Duration | Skills Required | Availability | |------|---------------|----------|-----------------|--------------| | Technical Writer | {writer_responsibility} | {writer_duration} | {writer_skills} | {writer_availability} | | Subject Matter Expert | {sme_responsibility} | {sme_duration} | {sme_skills} | {sme_availability} | | UX Designer | {ux_responsibility} | {ux_duration} | {ux_skills} | {ux_availability} | | Quality Assurance | {qa_responsibility} | {qa_duration} | {qa_skills} | {qa_availability} | | Project Manager | {pm_responsibility} | {pm_duration} | {pm_skills} | {pm_availability} | | **Total** | **{total_responsibility}** | **{total_duration}** | **{total_skills}** | **{total_availability}** | ### 🎯 **Technology & Tool Requirements** #### **Documentation Platform & Tools** - **Primary Platform**: {primary_platform} - **Authoring Tools**: {authoring_tools} - **Collaboration Tools**: {collaboration_tools} - **Quality Assurance Tools**: {qa_tools} - **Analytics & Monitoring**: {analytics_tools} - **Version Control**: {version_control} - **Deployment Tools**: {deployment_tools} #### **Infrastructure & Hosting** - **Hosting Requirements**: {hosting_requirements} - **Performance Requirements**: {performance_infrastructure} - **Security Requirements**: {security_infrastructure} - **Scalability Needs**: {scalability_requirements} - **Backup & Recovery**: {backup_strategy} - **Monitoring & Analytics**: {monitoring_infrastructure} ``` ## Automated Generation Variables ### 🔧 **Template Variables** ```yaml Template_Variables: project_metadata: - {project_id}: Unique project identifier - {project_name}: Human-readable project name - {documentation_type}: Type of documentation project - {spec_date}: Specification creation date - {current_date}: Current date (YYYY-MM-DD) - {current_time}: Current time (HH:MM:SS) audience_analysis: - {target_audiences}: Primary target audience groups - {user_personas}: Detailed user persona definitions - {user_journeys}: User journey mapping and analysis - {content_requirements}: Content requirements by audience - {quality_expectations}: Quality expectations and standards content_strategy: - {content_architecture}: Information architecture design - {content_types}: Content type specifications - {quality_standards}: Quality standards and compliance - {validation_procedures}: Quality validation procedures - {success_metrics}: Success measurement criteria implementation_planning: - {development_phases}: Development phase breakdown - {resource_allocation}: Team and resource requirements - {technology_requirements}: Technology and tool specifications - {timeline_planning}: Timeline and milestone planning - {risk_management}: Risk assessment and mitigation temporal_variables: - {current_date}: Auto-generated current date - {spec_timeline}: Specification development timeline - {implementation_schedule}: Implementation schedule details - {milestone_dates}: Milestone date planning ``` ### ⚡ **Automatic Date Integration** ```javascript // Automatic date generation for documentation specifications const currentDate = new Date().toISOString().split('T')[0]; // 2025-07-13 const currentTime = new Date().toTimeString().split(' ')[0]; // HH:MM:SS const specTimestamp = `${currentDate} ${currentTime}`; ``` This comprehensive documentation specification template provides DocQA with a structured, automated approach to documenting documentation projects with audience analysis, content strategy, quality standards, and implementation planning, ensuring complete traceability and accountability for all documentation development activities across the JAEGIS ecosystem. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://jaegis.gitbook.io/JAEGIS/jaegis-method-v2.0-v2.1.1-jaegis-jaegis-method-jaegis-agent-templates-documentation-specification.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.