speccrew 0.1.0

package/workspace-template/docs/configs/document-templates.json

@@ -0,0 +1,667 @@
+{
+  "version": "1.0.0",
+  "description": "Document templates metadata for knowledge generation across all skills",
+  "last_updated": "2026-03-23",
+  "templates": {
+    "module_overview": {
+      "name": "MODULE-OVERVIEW-TEMPLATE",
+      "file_name": "MODULE-OVERVIEW-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/MODULE-OVERVIEW-TEMPLATE.md",
+      "description": "Template for generating initial module overview with feature list",
+      "used_by": ["speccrew-knowledge-module-analyze"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "{module_name}-overview.md",
+      "sections": [
+        {
+          "name": "Module Basic Info",
+          "required": true,
+          "description": "Module name, purpose, and domain"
+        },
+        {
+          "name": "Feature List",
+          "required": true,
+          "description": "Table of features with API endpoints and status"
+        },
+        {
+          "name": "Architecture Overview",
+          "required": false,
+          "description": "Module structure diagram and dependencies"
+        },
+        {
+          "name": "Data Model",
+          "required": false,
+          "description": "Entity relationships and key entities"
+        },
+        {
+          "name": "API Summary",
+          "required": false,
+          "description": "Summary of all APIs (marked as TBD in initial version)"
+        },
+        {
+          "name": "Business Rules",
+          "required": false,
+          "description": "Key business rules (marked as TBD in initial version)"
+        }
+      ],
+      "placeholders": [
+        "{{ModuleName}}",
+        "{{ModulePurpose}}",
+        "{{PlatformName}}",
+        "{{TechStack}}",
+        "{{FeatureList}}",
+        "{{ArchitectureDiagram}}"
+      ]
+    },
+    "feature_detail": {
+      "name": "FEATURE-DETAIL-TEMPLATE",
+      "file_name": "FEATURE-DETAIL-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/FEATURE-DETAIL-TEMPLATE.md",
+      "description": "Template for generating detailed feature documentation",
+      "used_by": ["speccrew-knowledge-module-analyze"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "features/{feature-name}.md",
+      "sections": [
+        {
+          "name": "Feature Overview",
+          "required": true,
+          "description": "Feature name, description, and purpose"
+        },
+        {
+          "name": "API Specification",
+          "required": true,
+          "description": "HTTP method, path, request/response DTOs"
+        },
+        {
+          "name": "Validation Rules",
+          "required": false,
+          "description": "Input validation constraints"
+        },
+        {
+          "name": "Business Rules",
+          "required": false,
+          "description": "Business logic and constraints"
+        },
+        {
+          "name": "Sequence Diagram",
+          "required": false,
+          "description": "Interaction flow diagram"
+        },
+        {
+          "name": "Source Files",
+          "required": true,
+          "description": "Traceability to source code"
+        }
+      ],
+      "placeholders": [
+        "{{FeatureName}}",
+        "{{ModuleName}}",
+        "{{ApiMethod}}",
+        "{{ApiPath}}",
+        "{{RequestDto}}",
+        "{{ResponseDto}}",
+        "{{ValidationRules}}",
+        "{{BusinessRules}}",
+        "{{SourceFiles}}"
+      ]
+    },
+    "system_overview": {
+      "name": "SYSTEM-OVERVIEW-TEMPLATE",
+      "file_name": "SYSTEM-OVERVIEW-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/SYSTEM-OVERVIEW-TEMPLATE.md",
+      "description": "Template for generating system-level summary document",
+      "used_by": ["speccrew-knowledge-system-summarize"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "system-summarize.md",
+      "sections": [
+        {
+          "name": "System Overview",
+          "required": true,
+          "description": "High-level system description and purpose"
+        },
+        {
+          "name": "Module Architecture",
+          "required": true,
+          "description": "Complete module dependency diagram"
+        },
+        {
+          "name": "Cross-Module Interactions",
+          "required": true,
+          "description": "Inter-module communication patterns"
+        },
+        {
+          "name": "Data Flow",
+          "required": true,
+          "description": "End-to-end data flow across modules"
+        },
+        {
+          "name": "Complete Feature Index",
+          "required": true,
+          "description": "Consolidated feature list from all modules"
+        },
+        {
+          "name": "Business Domain Summary",
+          "required": true,
+          "description": "Business domain overview and key entities"
+        }
+      ],
+      "placeholders": [
+        "{{SystemName}}",
+        "{{SystemPurpose}}",
+        "{{PlatformName}}",
+        "{{ModuleArchitecture}}",
+        "{{ModuleList}}",
+        "{{FeatureIndex}}",
+        "{{DataFlowDiagram}}"
+      ]
+    },
+    "index": {
+      "name": "INDEX-TEMPLATE",
+      "file_name": "INDEX-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/INDEX-TEMPLATE.md",
+      "description": "Template for generating knowledge base index",
+      "used_by": ["speccrew-knowledge-bizs-init", "speccrew-knowledge-techs-init"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "INDEX.md",
+      "sections": [
+        {
+          "name": "Platform Overview",
+          "required": true,
+          "description": "Platform name, type, and tech stack"
+        },
+        {
+          "name": "Module Index",
+          "required": true,
+          "description": "List of all modules with links"
+        },
+        {
+          "name": "Quick Navigation",
+          "required": true,
+          "description": "Links to system-summarize and other key docs"
+        }
+      ],
+      "placeholders": [
+        "{{PlatformName}}",
+        "{{PlatformType}}",
+        "{{TechStack}}",
+        "{{ModuleIndex}}",
+        "{{SystemSummarizeLink}}"
+      ]
+    },
+    "solution_plan": {
+      "name": "FEATURE-SPEC-TEMPLATE",
+      "file_name": "FEATURE-SPEC-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/FEATURE-SPEC-TEMPLATE.md",
+      "description": "Template for feature designer to create feature specification documents",
+      "used_by": ["speccrew-feature-designer"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "{feature-name}-feature-spec.md",
+      "sections": [
+        {
+          "name": "Feature Overview",
+          "required": true,
+          "description": "Feature name, description, and scope"
+        },
+        {
+          "name": "Problem Statement",
+          "required": true,
+          "description": "Problem being solved"
+        },
+        {
+          "name": "Feature Design",
+          "required": true,
+          "description": "Detailed feature design"
+        },
+        {
+          "name": "Implementation Plan",
+          "required": true,
+          "description": "Steps to implement the feature"
+        },
+        {
+          "name": "Related Knowledge",
+          "required": false,
+          "description": "Links to relevant knowledge documents"
+        }
+      ],
+      "placeholders": [
+        "{{FeatureName}}",
+        "{{ProblemStatement}}",
+        "{{FeatureDesign}}",
+        "{{ImplementationPlan}}",
+        "{{RelatedKnowledge}}"
+      ]
+    },
+    "system_design_frontend": {
+      "name": "SD-FRONTEND-TEMPLATE",
+      "file_name": "SD-FRONTEND-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/SD-FRONTEND-TEMPLATE.md",
+      "description": "Template for system designer to create frontend detailed design documents",
+      "used_by": ["speccrew-system-designer"],
+      "applies_to": {
+        "system_types": ["ui"],
+        "platforms": ["web", "mobile", "desktop"]
+      },
+      "output_pattern": "{feature-name}-frontend-design.md",
+      "sections": [
+        {
+          "name": "Design Overview",
+          "required": true,
+          "description": "Frontend design overview and scope"
+        },
+        {
+          "name": "Component Architecture",
+          "required": true,
+          "description": "Component structure and hierarchy"
+        },
+        {
+          "name": "State Management",
+          "required": true,
+          "description": "State flow and management patterns"
+        },
+        {
+          "name": "API Integration",
+          "required": true,
+          "description": "API calls and data handling"
+        },
+        {
+          "name": "UI Specifications",
+          "required": false,
+          "description": "Styling, theming, and responsive design"
+        }
+      ],
+      "placeholders": [
+        "{{FeatureName}}",
+        "{{ComponentArchitecture}}",
+        "{{StateManagement}}",
+        "{{APIIntegration}}",
+        "{{UISpecifications}}"
+      ]
+    },
+    "system_design_backend": {
+      "name": "SD-BACKEND-TEMPLATE",
+      "file_name": "SD-BACKEND-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/SD-BACKEND-TEMPLATE.md",
+      "description": "Template for system designer to create backend detailed design documents",
+      "used_by": ["speccrew-system-designer"],
+      "applies_to": {
+        "system_types": ["api"],
+        "platforms": ["backend", "api"]
+      },
+      "output_pattern": "{feature-name}-backend-design.md",
+      "sections": [
+        {
+          "name": "Design Overview",
+          "required": true,
+          "description": "Backend design overview and scope"
+        },
+        {
+          "name": "Service Architecture",
+          "required": true,
+          "description": "Service layering and structure"
+        },
+        {
+          "name": "API Endpoints",
+          "required": true,
+          "description": "API endpoint definitions"
+        },
+        {
+          "name": "Data Model",
+          "required": true,
+          "description": "Database schema and data access"
+        },
+        {
+          "name": "Integration Points",
+          "required": false,
+          "description": "External service integrations"
+        }
+      ],
+      "placeholders": [
+        "{{FeatureName}}",
+        "{{ServiceArchitecture}}",
+        "{{APIEndpoints}}",
+        "{{DataModel}}",
+        "{{IntegrationPoints}}"
+      ]
+    },
+    "system_design_mobile": {
+      "name": "SD-MOBILE-TEMPLATE",
+      "file_name": "SD-MOBILE-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/SD-MOBILE-TEMPLATE.md",
+      "description": "Template for system designer to create mobile detailed design documents",
+      "used_by": ["speccrew-system-designer"],
+      "applies_to": {
+        "system_types": ["ui"],
+        "platforms": ["mobile"]
+      },
+      "output_pattern": "{module-name}-design.md",
+      "sections": [
+        {
+          "name": "Design Goal",
+          "required": true,
+          "description": "Module design objective and Feature Spec reference"
+        },
+        {
+          "name": "Screen Architecture",
+          "required": true,
+          "description": "Screen/widget tree and screen summary"
+        },
+        {
+          "name": "Navigation Design",
+          "required": true,
+          "description": "Navigation stack, deep linking, and route guards"
+        },
+        {
+          "name": "State Management",
+          "required": true,
+          "description": "Store/provider design with actions and selectors"
+        },
+        {
+          "name": "API Layer",
+          "required": true,
+          "description": "API functions, error handling, and caching strategy"
+        },
+        {
+          "name": "Local Storage",
+          "required": true,
+          "description": "Storage strategy, schema, and sync patterns"
+        },
+        {
+          "name": "Platform Features",
+          "required": false,
+          "description": "Permissions, native integration, and platform channels"
+        },
+        {
+          "name": "Unit Test Points",
+          "required": true,
+          "description": "Key test scenarios for screens, state, and API layer"
+        }
+      ],
+      "placeholders": [
+        "ModuleName",
+        "PlatformId",
+        "Framework",
+        "Language",
+        "FeatureSpecPath",
+        "ApiContractPath"
+      ]
+    },
+    "system_design_desktop": {
+      "name": "SD-DESKTOP-TEMPLATE",
+      "file_name": "SD-DESKTOP-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/SD-DESKTOP-TEMPLATE.md",
+      "description": "Template for system designer to create desktop detailed design documents",
+      "used_by": ["speccrew-system-designer"],
+      "applies_to": {
+        "system_types": ["ui"],
+        "platforms": ["desktop"]
+      },
+      "output_pattern": "{module-name}-design.md",
+      "sections": [
+        {
+          "name": "Design Goal",
+          "required": true,
+          "description": "Module design objective and Feature Spec reference"
+        },
+        {
+          "name": "Process Architecture",
+          "required": true,
+          "description": "Main/renderer process model and responsibilities"
+        },
+        {
+          "name": "Window Design",
+          "required": true,
+          "description": "Window configuration, lifecycle, and multi-window communication"
+        },
+        {
+          "name": "IPC Communication",
+          "required": true,
+          "description": "IPC channel registry, message types, and handlers"
+        },
+        {
+          "name": "UI Component Design",
+          "required": true,
+          "description": "Component tree, detail design with desktop patterns"
+        },
+        {
+          "name": "Native Integration",
+          "required": true,
+          "description": "File system, system tray, menu bar, notifications, shortcuts"
+        },
+        {
+          "name": "Security Design",
+          "required": true,
+          "description": "Context isolation, preload scripts, CSP"
+        },
+        {
+          "name": "Unit Test Points",
+          "required": true,
+          "description": "Key test scenarios for processes, IPC, and UI"
+        }
+      ],
+      "placeholders": [
+        "ModuleName",
+        "PlatformId",
+        "Framework",
+        "Language",
+        "FeatureSpecPath",
+        "ApiContractPath"
+      ]
+    },
+    "techs_index": {
+      "name": "TECHS-INDEX-TEMPLATE",
+      "file_name": "TECHS-INDEX-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/TECHS-INDEX-TEMPLATE.md",
+      "description": "Template for generating technology knowledge index for techs layer",
+      "used_by": ["speccrew-knowledge-techs-generate"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "INDEX.md",
+      "placeholders": [
+        "{{platform_name}}",
+        "{{platform_id}}",
+        "{{platform_type}}",
+        "{{framework}}",
+        "{{language}}",
+        "{{source_path}}"
+      ]
+    },
+    "tech_stack": {
+      "name": "TECH-STACK-TEMPLATE",
+      "file_name": "TECH-STACK-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/TECH-STACK-TEMPLATE.md",
+      "description": "Template for documenting technology stack details",
+      "used_by": ["speccrew-knowledge-techs-generate"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "tech-stack.md",
+      "placeholders": [
+        "{{platform_name}}",
+        "{{architecture_type}}",
+        "{{directory_structure}}",
+        "{{modules}}",
+        "{{module_relations}}"
+      ]
+    },
+    "architecture": {
+      "name": "ARCHITECTURE-TEMPLATE",
+      "file_name": "ARCHITECTURE-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/ARCHITECTURE-TEMPLATE.md",
+      "description": "Template for documenting architecture conventions and patterns",
+      "used_by": ["speccrew-knowledge-techs-generate"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "architecture.md",
+      "placeholders": [
+        "{{platform_name}}",
+        "{{directory_structure}}",
+        "{{structure_components}}",
+        "{{structure_relations}}"
+      ]
+    },
+    "conventions_design": {
+      "name": "CONVENTIONS-DESIGN-TEMPLATE",
+      "file_name": "CONVENTIONS-DESIGN-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/CONVENTIONS-DESIGN-TEMPLATE.md",
+      "description": "Template for documenting design conventions",
+      "used_by": ["speccrew-knowledge-techs-generate"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "conventions-design.md"
+    },
+    "conventions_dev": {
+      "name": "CONVENTIONS-DEV-TEMPLATE",
+      "file_name": "CONVENTIONS-DEV-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/CONVENTIONS-DEV-TEMPLATE.md",
+      "description": "Template for documenting development conventions",
+      "used_by": ["speccrew-knowledge-techs-generate"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "conventions-dev.md"
+    },
+    "conventions_test": {
+      "name": "CONVENTIONS-UNIT-TEST-TEMPLATE",
+      "file_name": "CONVENTIONS-UNIT-TEST-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/CONVENTIONS-UNIT-TEST-TEMPLATE.md",
+      "description": "Template for documenting unit testing conventions",
+      "used_by": ["speccrew-knowledge-techs-generate"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "conventions-unit-test.md"
+    },
+    "conventions_system_test": {
+      "name": "CONVENTIONS-SYSTEM-TEST-TEMPLATE",
+      "file_name": "CONVENTIONS-SYSTEM-TEST-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/CONVENTIONS-SYSTEM-TEST-TEMPLATE.md",
+      "description": "Template for documenting system testing conventions (E2E, integration, API contract testing)",
+      "used_by": ["speccrew-knowledge-techs-generate"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "conventions-system-test.md"
+    },
+    "conventions_data": {
+      "name": "CONVENTIONS-DATA-TEMPLATE",
+      "file_name": "CONVENTIONS-DATA-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/CONVENTIONS-DATA-TEMPLATE.md",
+      "description": "Template for documenting data conventions",
+      "used_by": ["speccrew-knowledge-techs-generate"],
+      "applies_to": {
+        "system_types": ["ui", "api"],
+        "platforms": ["web", "mobile", "backend", "desktop", "api"]
+      },
+      "output_pattern": "conventions-data.md"
+    },
+    "dev_task_frontend": {
+      "name": "DEV-TASK-FRONTEND-TEMPLATE",
+      "file_name": "DEV-TASK-FRONTEND-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/DEV-TASK-FRONTEND-TEMPLATE.md",
+      "description": "Template for frontend development task records",
+      "used_by": ["speccrew-dev-frontend"],
+      "applies_to": {
+        "system_types": ["ui"],
+        "platforms": ["web", "desktop"]
+      },
+      "dir": "ITERATION_DOCS_DIR/04.development",
+      "filename": "{feature-name}-tasks.md"
+    },
+    "dev_task_backend": {
+      "name": "DEV-TASK-BACKEND-TEMPLATE",
+      "file_name": "DEV-TASK-BACKEND-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/DEV-TASK-BACKEND-TEMPLATE.md",
+      "description": "Template for backend development task records",
+      "used_by": ["speccrew-dev-backend"],
+      "applies_to": {
+        "system_types": ["api"],
+        "platforms": ["backend", "api"]
+      },
+      "dir": "ITERATION_DOCS_DIR/04.development",
+      "filename": "{feature-name}-tasks.md"
+    },
+    "dev_task_mobile": {
+      "name": "DEV-TASK-MOBILE-TEMPLATE",
+      "file_name": "DEV-TASK-MOBILE-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/DEV-TASK-MOBILE-TEMPLATE.md",
+      "description": "Template for mobile development task records",
+      "used_by": ["speccrew-dev-mobile"],
+      "applies_to": {
+        "system_types": ["ui"],
+        "platforms": ["mobile"]
+      },
+      "dir": "ITERATION_DOCS_DIR/04.development",
+      "filename": "{feature-name}-tasks.md"
+    },
+    "dev_task_desktop": {
+      "name": "DEV-TASK-DESKTOP-TEMPLATE",
+      "file_name": "DEV-TASK-DESKTOP-TEMPLATE.md",
+      "path": "speccrew-workspace/docs/templates/DEV-TASK-DESKTOP-TEMPLATE.md",
+      "description": "Template for desktop development task records",
+      "used_by": ["speccrew-dev-desktop"],
+      "applies_to": {
+        "system_types": ["ui"],
+        "platforms": ["desktop"]
+      },
+      "dir": "ITERATION_DOCS_DIR/04.development",
+      "filename": "{feature-name}-tasks.md"
+    },
+    "tech_debt": {
+      "id": "tech_debt",
+      "dir": "ITERATION_DOCS_DIR/tech-debt",
+      "filename": "{debt-id}.md"
+    }
+  },
+  "template_rules": {
+    "language_adaptation": {
+      "description": "All templates must support language parameter",
+      "valid_languages": ["zh", "en", "ja", "ko", "fr", "de", "es"],
+      "default": "zh"
+    },
+    "source_traceability": {
+      "description": "All generated documents must include source file references",
+      "required_blocks": [
+        "Referenced Files block at document start",
+        "Diagram Source after each Mermaid diagram",
+        "Section Source at end of major sections"
+      ]
+    },
+    "mermaid_compatibility": {
+      "description": "All diagrams must follow mermaid-rule.md guidelines",
+      "reference": "speccrew-workspace/docs/rules/mermaid-rule.md"
+    }
+  },
+  "versioning": {
+    "strategy": "semantic_versioning",
+    "format": "major.minor.patch",
+    "update_triggers": [
+      "Template structure changes",
+      "New placeholders added",
+      "Section requirements changed"
+    ]
+  }
+}