Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

Documentation Hub

Central navigation for all project documentation.

🚀 Quick Start

New to the project? Start here:

  1. Quick Start Guide - Deploy Node Doctor, import dashboards, configure monitors
  2. Task Execution Workflow - Mandatory development process
  3. Template README - Template usage guide

📚 Core Documentation

Development Standards

Location: docs/development/

Essential reading for all developers:

Workflows

Location: docs/workflows/

Standard process workflows:

🎯 By Role

For Developers

  1. Task Execution Workflow
  2. API Handler Architecture
  3. Local CI/CD Validation
  4. Feature Development Workflow

For DevOps/SRE

  1. Helm Chart Standards
  2. Deployment Workflow
  3. Local CI/CD Validation

For Architects

  1. Database Patterns Guide
  2. Architecture Review Workflow
  3. Design Documentation

For Product/QA

  1. PRD Creation Workflow
  2. Testing Strategy
  3. TaskForge Usage Guide

For Project Managers

  1. Master Task Management
  2. TaskForge Usage Guide
  3. Sprint Management Workflow

📂 Directory Structure

docs/
├── README.md                   # This file - navigation hub
├── development/                # Core standards and guides (30 files)
│   ├── task-execution-workflow.md
│   ├── master-task-management.md
│   ├── taskforge-usage-guide.md
│   ├── api-handler-architecture-standards.md
│   ├── helm-chart-standards.md
│   └── ... (see development/ for full list)
├── workflows/                  # Process workflows
│   ├── feature-development.md
│   ├── project-initialization.md
│   ├── prd-creation.md
│   └── ...
├── design/                     # Architecture and design specs
├── operations/                 # Deployment and operations guides
├── testing/                    # Testing strategies and guides
├── security/                   # Security policies and procedures
├── examples/                   # Configuration examples
└── archive/                    # Historical documentation

🔍 Finding Documentation

By Topic

  • Task Management: development/master-task-management.md, development/taskforge-usage-guide.md
  • Quality Assurance: development/task-execution-workflow.md (quality gates and QA process)
  • API Development: development/api-handler-architecture-standards.md, development/error-response-standard.md
  • Database: development/database-patterns-guide.md
  • Deployment: development/helm-chart-standards.md, workflows/deployment.md
  • Testing: development/local-cicd-validation-guide.md, workflows/testing-strategy.md
  • Frontend: development/web-ui-api-synchronization.md
  • Operations: troubleshooting.md - Common issues, debugging, performance tuning

By Question

🎓 Learning Path

Week 1: Foundation

  1. Read Task Execution Workflow
  2. Read Master Task Management
  3. Try a small task following the workflow

Week 2: Standards

  1. Read API Handler Architecture Standards
  2. Read Helm Chart Standards
  3. Read Local CI/CD Validation Guide
  4. Practice validation locally

Week 3: Workflows

  1. Read Feature Development Workflow
  2. Read Deployment Workflow
  3. Complete a feature following workflows
  4. Get QA and Devils Advocate review

Week 4: Mastery

  1. Review all skeptic agents
  2. Understand quality gates deeply
  3. Mentor others on the process
  4. Contribute documentation improvements

📝 Documentation Standards

Creating Documentation

  1. Use Markdown: GitHub-flavored markdown
  2. Clear Structure: Headings, lists, code blocks
  3. Cross-Reference: Link to related docs
  4. Examples: Include practical examples
  5. Update Date: Add "Last Updated" footer

Organizing Documentation

  • development/: Standards, guides, and patterns
  • workflows/: Step-by-step process documentation
  • design/: Architecture and design decisions
  • operations/: Deployment and operational guides
  • examples/: Configuration examples
  • archive/: Historical documentation (not current)

Maintaining Documentation

  • Review quarterly for accuracy
  • Update when processes change
  • Archive obsolete documentation
  • Keep examples current
  • Test documented procedures

🔄 Documentation Updates

This documentation is living and should evolve with the project:

  • Add: New standards, workflows, or guides
  • Update: When processes change
  • Archive: When practices become obsolete
  • Link: Cross-reference related documentation
  • Example: Add real-world examples

💡 Contributing

When adding documentation:

  1. Determine correct directory
  2. Use clear, descriptive filename
  3. Follow markdown standards
  4. Add cross-references
  5. Update this README if needed
  6. Include examples
  7. Test instructions work

❓ Getting Help

  • Can't find documentation? Check this README or search repository
  • Documentation unclear? Open an issue or ask the team
  • Want to contribute? Follow contribution guidelines

🎯 Remember

Documentation is code. It should be:

  • Version controlled
  • Peer reviewed
  • Tested for accuracy
  • Updated regularly
  • Easy to find and navigate

Good documentation saves hours of confusion and prevents mistakes.

Last Updated: 2025-10-29 Maintained By: Development Team