Flow Overview

1. Definition

A Flow is a Markdown document that combines agreement constraints with multi-party process guidance for building service-side business workflows.

2. Specification

2.1 Summary

2.1.1 Document Purpose

Describe what problem the flow solves and which roles it serves.

2.1.2 Business Process

Describe the workflow steps and key states.

2.2 Referenced Agreements

List dependent agreement names and versions.

2.3 Internal Notes

Document implementation constraints and engineering notes for service owners.

2.4 External Notes

Document integration instructions for consumers/integrators.

2.5 Work

2.5.1 Preparation

2.5.1.1 Environment and Technical Choices

Define runtime prerequisites and stack decisions.

2.5.2 Workspace Layout

Explain folder conventions and artifacts.

2.5.3 Process Log (meta.json)

Record key execution events, version changes, and state.

2.5.4 Deliverables

Expected outputs include application, README, and test results.

2.5.5 Error Handling

Define error categories, handling workflow, and rollback strategy.

3. Template

Use a standard Flow template for consistent structure.

4. Example: sample-shop-flow

Use sample-shop-flow as the sample flow name.

5. Agreement Validator

In Hub navigation, open Agreement and look for the validator entry on the list page to validate agreement.json.