Instruction File Refactors
- Joshua Lamos-Sweeney
Document status | DRAFT |
|---|---|
Document owner | @Joshua Lamos-Sweeney +@Luke Cook |
Designer | @Luke Cook |
Tech lead | @Joshua Lamos-Sweeney |
Technical writers | TBD |
QA | TBD |
Objective
Simplify the miriad of structures, many no longer consistent even inside the file, in the instruction files for the DIgest and Extract back end processes. Allow for significant increases in readability and reduce the error rate from malformed files being improperly generated or mis-interpreted.
Concept
The instruction file contains many duplicate entries, and many pieces of data that only apply in very specific scenarios. This refactor aims to reduce this duplication as much as possible through consolidating these functions and removing unneeded elements.
Implementation Decisions
See : Instruction File
Success metrics
Goal | Metric | Succeeded |
|---|---|---|
Works with Existing UIs | Does everything still work? | @Joshua Lamos-Sweeney verifies this |
Improved readability | Is the file more readable? | The file is smaller, and entities actually make sense. |
Reduced errors in system | Do we continue to suffer regular IPC failures? | @Joshua Lamos-Sweeney has seen a significant reduction in issues related to the instruction file |