Skip to content

Documentation Hub#

Welcome to the central documentation hub for this project. All requirements, specifications, diagrams, and related documentation are organized here.

📋 Master Index#

Start here: INDEX.md - Complete documentation overview and navigation

🚀 Getting Started#

For New Team Members#

  1. Read the Master Index to understand the documentation structure
  2. Review existing Requirements to understand project goals
  3. Check the Specification Cross-Reference Table to see what's implemented
  4. Familiarize yourself with Rules to understand coding standards

For Adding New Features#

Quick Start: Use workflow orchestration prompts: - Requirements → Specification Workflow - Generates spec, threat model, architecture diagram with quality review - Specification → Code Workflow - TDD implementation with security and quality reviews

Or step-by-step: 1. Requirements: Create a new requirement in requirements/ using the template 2. Specifications: Generate or write a specification in specifications/ using the template 3. Diagrams: Create architecture diagrams and threat models in diagrams/ 4. Implementation: Follow the TDD workflow in .github/instructions/master-workflow.md 5. Quality Gates: Validate against quality checklists 6. Cross-Reference: Update SPEC-CROSS-REFERENCE.md to track your work

Practical Examples: See Workflow Usage Guide for step-by-step examples

🤖 AI Assistant Integration#

This documentation structure works with both Claude Code and GitHub Copilot:

📁 Folder Structure#

docs/
├── INDEX.md                      # Master index (start here!)
├── SPEC-CROSS-REFERENCE.md       # Implementation tracking table
├── README.md                     # This file
├── requirements/                 # Feature requirements
├── specifications/               # Technical specifications
├── diagrams/                     # Architecture, threat models, etc.
├── rules/                        # Standards and conventions
├── templates/                    # Documentation templates
├── history/                      # Decision logs
└── output-logs/                  # Workflow execution logs

🔄 Documentation Workflow#

This project follows a specification-driven development approach:

Requirements → Specifications → Code Generation (TDD) → Quality Review → Approval

Each stage has human approval gates and automated quality checks. See the Master Workflow for complete details.

🛠️ Automation#

Documentation can be automatically updated using: - GitHub Actions - Pre-commit hooks - Manual scripts

See .github/instructions/ for automation setup guides.

📚 Additional Resources#

Note: This is a template repository. When you use this template for a new project, start by creating your first requirement in requirements/ and following the workflow from there.