3.8 KiB
Project Thoth Work Order Template
Work Order ID: XXXX
Title: <Concise descriptive title>{=html}
Status
Draft | Ready | In Progress | Blocked | Complete
Work Stream
- Implementation
- Refactoring
- Debugging
- Research
- Documentation
- Testing
Application / Component
Name of the application, connector, processor, or specification affected.
Objective
A one-paragraph description of the desired outcome.
Background
Describe the current situation and why this work is needed.
Include links or references to previous work orders when appropriate.
Architectural References
List all governing architectural documents.
Example:
- Reference Architecture
- ADR-001
- ADR-002
- ADR-003
- .thoth/10-architecture.md
- .thoth/20-philosophy.md
- .thoth/40-coding-standards.md
Problem Statement
Describe the observable problem.
Focus on facts rather than implementation assumptions.
Scope
In Scope
- Item
- Item
Out of Scope
- Item
- Item
Requirements
Describe the functional and technical requirements.
Organize by logical area.
Example sections:
- Discovery
- Transformation
- Serialization
- User Interface
- Error Handling
- Performance
- Security
Deliverables
List the expected outputs.
Examples:
- Source code
- Documentation
- Tests
- Configuration
- Specifications
Proposed Implementation
Describe the preferred implementation strategy.
Include suggested modules, interfaces, file structure, or pipeline where helpful.
Constraints
Document important limitations.
Examples:
- Maintain backward compatibility
- No LLM calls
- Preserve deterministic behavior
- Do not modify canonical artifacts
- No vendor lock-in
Acceptance Criteria
Provide objective, testable criteria.
Each criterion should be independently verifiable.
Manual Test Plan
Describe how the work will be validated.
Include representative test cases and expected outcomes.
Risks
Document known risks and mitigation strategies.
Non-Goals
Explicitly identify work that is intentionally excluded.
Definition of Done
The work order is complete when:
- Acceptance criteria are satisfied.
- Relevant documentation has been updated.
- Code aligns with applicable ADRs.
- No known regressions have been introduced.
- Outstanding technical debt is documented.
Notes
Optional implementation notes, observations, or future follow-up items.
Revision History
Date Author Description
YYYY-MM-DD Initials Initial draft