Following are the suggested guidelines that can be used for the design across tracks:
- Each track should create a page under the use the relevant flows in the respective child pages of the Use case flows page. The page should contain the following contents:
- Sequence diagram for each workflow that will be realized under the track.
- Interface details which will be derived from the sequence diagram (easier for the designers to identify the touchpoints touch points and corresponding APIs)
- Component Brief component level impact and functionality for each flow. This can also be derived from the sequence diagram.
- All API documentation should come under the corresponding project's page . (under Impacted Modules--Design Details. Once APIs are agreed, they will be removed from the sub-pages in Impacted Modules--Design Details and replaced with links to swagger. This will avoid the redundant info across the wiki pages which in turn will avoid any misalignment)Once, the API documentation is finalized, the swagger doc in the repo must be updated to match the API docs in the wiki. (.
- All the developers can agree to use the swagger doc as the point of reference because it is being tracked by a version control system).
- The component impacts must be agreed with the PTL. , if not already done (to avoid any confusions during the development).
- Please keep the module responsible and track responsible in the loop for all the discussions that happen for your respective track/module. Details of module and track responsible are available at Use Case Contacts Info in Guilin release.