Files
firefrost-operations-manual/docs/standards
mkrause612 446d525dea Add Task Documentation Standard (FFG-STD-002)
Establishes systematic approach to task documentation:

PROBLEM SOLVED:
- Tasks.md becoming unwieldy with mixed detail levels
- Implementation details buried in master task list
- Hard to find related documentation
- Duplication and sync issues
- Context muddying

SOLUTION:
- Each task gets dedicated directory in docs/tasks/
- Tasks.md stays high-level (executive summary only)
- Clear separation: planning vs implementation vs operations
- Scalable structure (1 to 20 docs per task)

STRUCTURE:
docs/tasks/[task-name]/
  ├── README.md (required - overview)
  ├── deployment-plan.md (if building)
  ├── usage-guide.md (if tool/service)
  ├── troubleshooting.md (if operational)
  ├── maintenance.md (ongoing ops)
  └── config-examples/ (as needed)

APPLICATION:
- All NEW tasks follow this pattern immediately
- Existing tasks migrate gradually (when touched)
- No breaking changes to existing docs

BENEFITS:
- Discoverable (all task docs in one place)
- Maintainable (update one location)
- Scalable (50+ tasks, tasks.md stays readable)
- Collaborative (clear where to look)

FIRST TASK USING STANDARD:
- Whitelist Manager (docs/tasks/whitelist-manager/)

Created by: The Chronicler
Date: February 16, 2026
Standard ID: FFG-STD-002
2026-02-16 05:50:38 -06:00
..