Readme

EPGOAT Documentation - User Guides

02-Guides

Purpose: Task-oriented, step-by-step guides for common operations and workflows.

What Belongs Here

✅ Include: - How-to guides for specific tasks - Step-by-step walkthroughs - Setup and configuration guides - Development workflows - Common operations and procedures - Troubleshooting workflows (when process-oriented)

❌ Don't Include: - Conceptual architecture (use 03-Architecture/ instead) - API reference documentation (use 05-Reference/API/ instead) - Problem → Solution mappings (use 07-Troubleshooting/ instead) - One-time project work (use 01-Work-In-Progress/ instead)

Key Files

  • Quick-Start.md: Get started quickly with the project
  • Development-Setup.md: Complete development environment setup (WIP)
  • EPG-Generation.md: How to generate EPG files (WIP)
  • Pattern-Matching.md: How to work with channel patterns (WIP)
  • Testing-Guide.md: How to write and run tests (WIP)

Writing Guidelines

Good guides should: 1. Start with the goal: "How to X" 2. List prerequisites: What you need before starting 3. Show concrete examples: Real commands, real files 4. Include expected output: What success looks like 5. Link to reference docs: For detailed specifications 6. Mention common pitfalls: What to watch out for

When to Create a New Guide

Create a guide when: - A task is performed repeatedly by multiple people - The task involves multiple steps across different tools/files - There's tribal knowledge that needs documentation - Users frequently ask "how do I...?"

Last Updated: 2025-11-05