Writing specifications for workflow automation solutions
The key outputs of the design process are:
- Functional Workflow diagram
- Technical Workflow diagram
- Solution Architecture Diagram
- Data element mapping specifications
Given these, you’ll be ready to finalize your workflow specifications and hand off to developers for job-writing!
Each “task” or “step” in the OpenFn swimlane of your technical diagram can be implemented as a distinct operation in your workflow configuration. In the example diagram below, you might implement 1 job with 3 chained operations, or 3 jobs with 1 operation each.
The workflow specifications should link to all of the design artifacts and highlight the following:
- The required number of OpenFn jobs and the function of each
- Links to sample input/output and API documentation
- Unique identifiers
- Expected data volumes
- Authentication requirements