81 lines
3.0 KiB
Markdown
81 lines
3.0 KiB
Markdown
# {{TECHNICAL_DOCUMENT_TYPE}} - {{PROJECT_NAME}}
|
|
|
|
[[LLM: This comprehensive {{TECHNICAL_DOCUMENT_TYPE}} ensures all {{TECHNICAL_DOMAIN}} requirements are properly documented for {{TARGET_USE_CASE}}.]]
|
|
|
|
## {{SPECIFICATION_OVERVIEW_SECTION}}
|
|
|
|
### Basic Information
|
|
**{{SPEC_IDENTIFIER_LABEL}}**: {{SPEC_IDENTIFIER}}
|
|
**{{SPEC_VERSION_LABEL}}**: {{SPEC_VERSION}}
|
|
**{{CREATION_DATE_LABEL}}**: {{CREATION_DATE}}
|
|
**{{RESPONSIBLE_ENGINEER_LABEL}}**: {{RESPONSIBLE_ENGINEER}}
|
|
|
|
### {{PROJECT_SCOPE_SUBSECTION}}
|
|
**{{PROJECT_TYPE_LABEL}}**: {{PROJECT_TYPE}}
|
|
**{{TARGET_APPLICATION_LABEL}}**: {{TARGET_APPLICATION}}
|
|
**{{COMPLEXITY_LEVEL_LABEL}}**: {{COMPLEXITY_LEVEL}}
|
|
**{{COMPLIANCE_REQUIREMENTS_LABEL}}**: {{COMPLIANCE_REQUIREMENTS}}
|
|
|
|
[[LLM: {{SCOPE_DEFINITION_GUIDANCE}}]]
|
|
|
|
## {{TECHNICAL_REQUIREMENTS_SECTION}}
|
|
|
|
### {{FUNCTIONAL_REQUIREMENTS_SUBSECTION}}
|
|
{{#each functional_requirements}}
|
|
**{{requirement_id}}**: {{requirement_description}}
|
|
- Priority: {{requirement_priority}}
|
|
- Acceptance Criteria: {{acceptance_criteria}}
|
|
- Testing Method: {{testing_method}}
|
|
{{/each}}
|
|
|
|
### {{PERFORMANCE_REQUIREMENTS_SUBSECTION}}
|
|
**{{PERFORMANCE_METRIC_1_LABEL}}**: {{PERFORMANCE_METRIC_1_VALUE}}
|
|
**{{PERFORMANCE_METRIC_2_LABEL}}**: {{PERFORMANCE_METRIC_2_VALUE}}
|
|
**{{PERFORMANCE_METRIC_3_LABEL}}**: {{PERFORMANCE_METRIC_3_VALUE}}
|
|
|
|
[[LLM: {{PERFORMANCE_GUIDANCE}}]]
|
|
|
|
## {{TECHNICAL_ARCHITECTURE_SECTION}}
|
|
|
|
### {{SYSTEM_DESIGN_SUBSECTION}}
|
|
**{{ARCHITECTURE_PATTERN_LABEL}}**: {{ARCHITECTURE_PATTERN}}
|
|
**{{TECHNOLOGY_STACK_LABEL}}**: {{TECHNOLOGY_STACK}}
|
|
**{{INTEGRATION_APPROACH_LABEL}}**: {{INTEGRATION_APPROACH}}
|
|
|
|
### {{COMPONENT_SPECIFICATIONS_SUBSECTION}}
|
|
<<REPEAT section="{{COMPONENT_SECTION_NAME}}" count="{{COMPONENT_COUNT}}">>
|
|
**{{component_name}}**:
|
|
- Function: {{component_function}}
|
|
- Technology: {{component_technology}}
|
|
- Interface: {{component_interface}}
|
|
- Dependencies: {{component_dependencies}}
|
|
<</REPEAT>>
|
|
|
|
## {{QUALITY_STANDARDS_SECTION}}
|
|
|
|
### {{TESTING_REQUIREMENTS_SUBSECTION}}
|
|
**{{TEST_TYPE_1_LABEL}}**: {{TEST_TYPE_1_REQUIREMENTS}}
|
|
**{{TEST_TYPE_2_LABEL}}**: {{TEST_TYPE_2_REQUIREMENTS}}
|
|
**{{TEST_TYPE_3_LABEL}}**: {{TEST_TYPE_3_REQUIREMENTS}}
|
|
|
|
### {{VALIDATION_CRITERIA_SUBSECTION}}
|
|
^^CONDITION: {{VALIDATION_TYPE}} == "{{COMPREHENSIVE_VALIDATION}}"^^
|
|
- [ ] {{VALIDATION_ITEM_1}}
|
|
- [ ] {{VALIDATION_ITEM_2}}
|
|
- [ ] {{VALIDATION_ITEM_3}}
|
|
- [ ] {{VALIDATION_ITEM_4}}
|
|
^^/CONDITION: {{VALIDATION_TYPE}}^^
|
|
|
|
## {{IMPLEMENTATION_GUIDANCE_SECTION}}
|
|
|
|
### {{DEVELOPMENT_PROCESS_SUBSECTION}}
|
|
**{{DEVELOPMENT_METHODOLOGY_LABEL}}**: {{DEVELOPMENT_METHODOLOGY}}
|
|
**{{TIMELINE_ESTIMATE_LABEL}}**: {{TIMELINE_ESTIMATE}}
|
|
**{{RESOURCE_REQUIREMENTS_LABEL}}**: {{RESOURCE_REQUIREMENTS}}
|
|
|
|
### {{DEPLOYMENT_SPECIFICATIONS_SUBSECTION}}
|
|
**{{DEPLOYMENT_ENVIRONMENT_LABEL}}**: {{DEPLOYMENT_ENVIRONMENT}}
|
|
**{{DEPLOYMENT_PROCESS_LABEL}}**: {{DEPLOYMENT_PROCESS}}
|
|
**{{MONITORING_REQUIREMENTS_LABEL}}**: {{MONITORING_REQUIREMENTS}}
|
|
|
|
[[LLM: {{IMPLEMENTATION_VALIDATION_GUIDANCE}}]] |