sead-method-core

Version:

Specification Enforced Agentic Agile Development - A hybrid methodology preventing AI agent drift through catalog-based constraints with comprehensive external asset integration

github.com/sead-method/core

sead-method/core

253 lines (196 loc) • 13.4 kB

Markdown

# SEAD Index Docs Task ## Purpose To create comprehensive, searchable documentation indexes that integrate SEAD catalog patterns, constitutional constraints, and agent context preservation. This task organizes project documentation to support effective agent handoffs, catalog pattern discovery, and constitutional compliance validation while maintaining documentation quality and accessibility. ## SEQUENTIAL Task Execution (Do not proceed until current Task is complete) ### 0. Load SEAD Configuration and Documentation Context - Load `{root}/sead.config.yaml` and `{root}/sead-core/core-config.yaml` from the project root - If files do not exist, HALT and inform the user: "SEAD configuration files not found. Run 'sead init' or 'sead catalog generate --source .' to initialize SEAD project" - Extract key configurations: `docs.*`, `catalog.*`, `modes.*`, `architecture.*`, `workflow.*` - **SEAD Enhancement**: Load catalog documentation requirements and pattern documentation standards - **SEAD Enhancement**: Validate current development mode for documentation completeness requirements - **SEAD Enhancement**: Check existing documentation structure and catalog integration ### 1. Documentation Discovery and Catalog Integration #### 1.1 Comprehensive Documentation Scanning - Scan project directories for documentation files: - README files at all levels (project, modules, components) - Markdown documentation in /docs/, /documentation/, and similar directories - Code comments and inline documentation - API documentation and schema files - Architecture decision records (ADRs) - Configuration and setup documentation - **SEAD Enhancement**: Identify catalog-related documentation: - Catalog pattern documentation and usage examples - Constitutional constraint documentation - Agent workflow and handoff documentation - Three-tier strategy documentation (data, deployment) - Pattern evolution and decision history #### 1.2 Documentation Classification with SEAD Framework - **SEAD Enhancement**: Classify documentation by SEAD categories: - **Constitutional Framework**: Governance, constraints, compliance documentation - **Catalog Patterns**: Pattern definitions, usage examples, evolution history - **Agent Context**: Workflow documentation, handoff requirements, context preservation - **Architecture**: System design, integration patterns, technical decisions - **Implementation**: Setup guides, development workflows, troubleshooting - **Quality Assurance**: Testing patterns, validation requirements, quality gates ### 2. Documentation Quality Assessment with Constitutional Standards #### 2.1 Content Quality Evaluation - **SEAD Enhancement**: Assess documentation against constitutional documentation standards: - Completeness: Coverage of all required SEAD components - Accuracy: Current and correct information aligned with catalog patterns - Clarity: Clear, actionable guidance for agents and developers - Consistency: Aligned with catalog pattern documentation standards - Context Preservation: Sufficient detail for effective agent handoffs #### 2.2 Catalog Pattern Documentation Validation - **SEAD Enhancement**: Validate catalog pattern documentation quality: - Pattern definitions include usage examples and integration guidance - Pattern evolution history preserved with decision rationale - Pattern dependencies and relationships clearly documented - Pattern compliance validation criteria specified - Cross-references between related patterns maintained ### 3. Documentation Structure Design with SEAD Architecture #### 3.1 Hierarchical Index Structure Creation - **SEAD Enhancement**: Design documentation index structure aligned with SEAD architecture: ``` docs-index/ ├── README.md # Master documentation index ├── constitutional-framework/ # SEAD governance documentation │ ├── index.md │ ├── constraints/ # Mode-specific constraints │ ├── compliance/ # Validation and quality gates │ └── governance/ # Constitutional principles and enforcement ├── catalog-patterns/ # Catalog pattern documentation │ ├── index.md │ ├── api-contracts/ # API pattern documentation with examples │ ├── shared-types/ # Type pattern documentation with usage │ ├── design-system/ # UI pattern documentation with components │ ├── state-management/ # State pattern documentation with flows │ ├── error-handling/ # Error pattern documentation with scenarios │ ├── auth-patterns/ # Authentication pattern documentation │ ├── integration-patterns/ # Integration pattern documentation │ ├── test-patterns/ # Testing pattern documentation │ ├── data-strategy/ # Data tier documentation │ └── deployment-strategy/ # Deployment tier documentation ├── agent-workflows/ # Agent and workflow documentation │ ├── index.md │ ├── agent-definitions/ # Individual agent documentation │ ├── workflow-guides/ # Workflow execution documentation │ ├── context-preservation/ # Agent handoff documentation │ └── task-templates/ # Task and template documentation ├── architecture/ # Technical architecture documentation │ ├── index.md │ ├── system-design/ # High-level architecture documentation │ ├── integration-points/ # Integration and dependency documentation │ ├── decision-records/ # Architecture decision records (ADRs) │ └── three-tier-strategy/ # Data and deployment strategy documentation └── implementation/ # Development and operations documentation ├── index.md ├── setup-guides/ # Project setup and configuration ├── development-workflows/ # Development process documentation ├── troubleshooting/ # Common issues and solutions └── quality-assurance/ # Testing and validation documentation ``` #### 3.2 Cross-Reference and Navigation Design - **SEAD Enhancement**: Design cross-referencing system for catalog pattern integration: - Pattern usage examples linked to relevant architecture documentation - Constitutional constraints linked to specific pattern compliance requirements - Agent workflow documentation linked to relevant catalog patterns - Implementation guides linked to pattern usage examples and validation criteria ### 4. Index Generation with Catalog Pattern Integration #### 4.1 Master Documentation Index Creation - **SEAD Enhancement**: Create comprehensive master index with SEAD integration: - Quick start guide with SEAD mode selection guidance - Catalog pattern quick reference with usage examples - Constitutional constraint summary with mode-specific requirements - Agent workflow overview with handoff procedures - Three-tier strategy summary with implementation guidance #### 4.2 Domain-Specific Index Generation - **SEAD Enhancement**: Generate specialized indexes for each documentation domain: **Constitutional Framework Index:** - Mode-specific constraint documentation with usage examples - Compliance validation procedures with quality gate requirements - Governance principles with enforcement mechanisms - Escalation procedures for constraint conflicts **Catalog Pattern Index:** - Pattern catalog with usage examples and integration guidance - Pattern evolution history with decision rationale - Pattern dependency maps with relationship documentation - Pattern validation criteria with compliance requirements **Agent Workflow Index:** - Agent definitions with capabilities and responsibilities - Workflow execution guides with context preservation requirements - Task templates with catalog pattern integration - Context handoff procedures with validation criteria ### 5. Search and Discovery Enhancement #### 5.1 Searchable Documentation Features - **SEAD Enhancement**: Implement search and discovery features for SEAD documentation: - Pattern-based search: Find catalog patterns by functionality or domain - Constraint-based search: Find constitutional requirements by mode or context - Agent-based search: Find workflow documentation by agent or task type - Context-based search: Find documentation by development context or phase #### 5.2 Documentation Tagging and Metadata - **SEAD Enhancement**: Add metadata and tagging for improved discovery: - SEAD mode tags: Prototype, development, build-to-deploy applicability - Catalog domain tags: API, types, UI, state, error, auth, integration, test, data, deployment - Agent workflow tags: Analyst, architect, developer, QA, scrum master, etc. - Context preservation tags: Handoff requirements, context dependencies, validation needs ### 6. Documentation Validation and Quality Assurance #### 6.1 Index Completeness Validation - **SEAD Enhancement**: Validate documentation index completeness: - All catalog patterns have corresponding documentation with examples - All constitutional constraints have clear guidance and validation procedures - All agent workflows have complete documentation with context preservation - All architectural decisions have documented rationale and implications #### 6.2 Documentation Consistency Validation - **SEAD Enhancement**: Validate documentation consistency across SEAD components: - Pattern documentation follows consistent format and structure - Constitutional constraint documentation uses standard terminology - Agent workflow documentation maintains consistent context preservation approach - Cross-references and links remain valid and current ### 7. Documentation Maintenance and Evolution Strategy #### 7.1 Documentation Update Procedures - **SEAD Enhancement**: Establish documentation maintenance procedures: - Pattern evolution triggers documentation updates with version tracking - Constitutional constraint changes require documentation revision - Agent workflow modifications trigger context preservation documentation updates - Architecture changes require cross-reference validation and updates #### 7.2 Documentation Quality Monitoring - **SEAD Enhancement**: Implement documentation quality monitoring: - Regular validation of documentation accuracy against current catalog patterns - Constitutional constraint documentation alignment with current enforcement - Agent workflow documentation validation against current capabilities - Link validation and cross-reference integrity checking ### 8. Documentation Index Finalization and Integration #### 8.1 Final Index Generation and Validation - **SEAD Enhancement**: Generate final documentation index with full SEAD integration: - Master index with comprehensive navigation and quick access - Domain-specific indexes with detailed pattern and constraint documentation - Search and discovery features for efficient documentation access - Validation reports confirming documentation completeness and consistency #### 8.2 Integration with SEAD Ecosystem - **SEAD Enhancement**: Integrate documentation index with SEAD development workflow: - CLI integration for documentation access during development - Agent workflow integration for context-aware documentation access - Catalog pattern integration for just-in-time documentation delivery - Constitutional constraint integration for compliance-aware documentation access ## SEAD Success Criteria - Documentation index comprehensively covers all SEAD components with clear navigation - Catalog pattern documentation includes practical examples and integration guidance - Constitutional constraint documentation provides clear compliance guidance - Agent workflow documentation supports effective context preservation and handoffs - Search and discovery features enable efficient documentation access during development - Documentation maintenance procedures ensure long-term accuracy and relevance ## SEAD Innovation Benefits - **Integrated Documentation**: SEAD-aware documentation structure supports catalog-driven development - **Context Preservation**: Documentation design facilitates effective agent handoffs and context continuity - **Constitutional Compliance**: Documentation structure reinforces constitutional constraint awareness - **Pattern Discovery**: Catalog pattern documentation enables efficient pattern reuse and evolution - **Development Efficiency**: Searchable, well-organized documentation reduces development friction ## Output Comprehensive documentation index system including: - Hierarchical documentation structure aligned with SEAD architecture - Master and domain-specific indexes with SEAD component integration - Search and discovery features for efficient documentation access - Documentation validation and quality assurance procedures - Integration with SEAD development workflow and agent ecosystem - Maintenance procedures for long-term documentation accuracy and relevance