Skip to content

Instantly share code, notes, and snippets.

@fmendes6

fmendes6/chapter_template.md

Last active April 4, 2020 19:22
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save fmendes6/96f2ebfb190b4aa522f660059f3d918d to your computer and use it in GitHub Desktop.
Save fmendes6/96f2ebfb190b4aa522f660059f3d918d to your computer and use it in GitHub Desktop.
Download ZIP
Raw
chapter_template.md

Provide a high level description of the architecture and how does the data flow.

                     +-------------+
+------------+       |             |
| Service    +<------+  Repository +
+------------+       |             |
                     |             |
                     +-------------+              
                            ^
                      +-----+-----+
                      |   Screen  |
                      +-----------+

Consider using a tool that generates ascii diagrams like AsciiFlow.

Component X (ex: Service)

Describe specific considerations that a component might have compared to others.

Operation Y (ex: Saving data, Tracking)

Describe what should be known regarding this operation. Any implementation detail that might be hard to grasp when reading the code?

FAQ

Include possible questions that your colleagues might have and their answers.

Ex: Why doesn't component X work in the component Z?

Ex: The service was updated, now what do I need to change?

Ex: Is there any postman collection?

References

PS: All hyperlinks in this template merely serve as an example and are to be defined by you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment