Home - schaman/tech GitHub Wiki
WTF
Checklist engine is a helper for manual event processing by humans.
HOW
Checklist consists of steps. Define steps, then fire an event. Human unit is required to check completed step in a list.
Step can be simple, or complex – consist of sub-steps. Complex step refers another checklist containing nested steps.
Tech
Tech is a checklist of steps.
Step can be simple, or complex – consist of sub-steps. Complex step contains child steps.
Step has:
- todo: step name in form of "what should one do to complete this step"
- ref: reference to the tech containing description and steps. If ref is present, there should be no desc or steps
- desc: more comprehensive explanation of what should be done, and tips&tricks / best practices
- steps: child steps
- outcome: step name in form of "what result should be gained to complete this step"
Interface
Tech list
- Flat list of all techs with links
Tech view
- Breadcrumbs: Techs (Link to tech list) / Tech name / Step name / Substep name / Substep name
- Tree: whole structure of current tech
- View: Todo, desc, child steps, outcome