Documentation
Explanation.
Links
- Sequence Diagrams | Mermaid Chart
(HN)
- Sequence diagram: visualize the dynamic flow of messages across systems. Map out "black boxes" and show how they interact
- Start with happy paths and then add edge cases. The flow of the happy path should remain as the anchor for other edge cases
- Comprehensiveness is the enemy of comprehensibility: the code is the best source of comprehensiveness, keep the diagrams simple for effective communication
- Add
ARCHITECTURE.md(Feb 2021) (HN)- Specify a codemap, not how but where is the code and what is it for
- Help occasional contributor to figure out where to find something
- Two open source projects with great documentation (HN)