(How-to Template)
Instructions:
- Create a diagram using https://excalidraw.com
- Save the Excalidraw file in
/media
- Save an SVG export of the diagram in
/src/assets/images
- Link to it above using a relative path
About (How-to guide)
Instructions:
- Write a brief overview of at most 3 paragraphs, about the size of a LinkedIn post
A how-to guide helps the user get something done, correctly and safely; it guides the user’s action.
It’s concerned with work - navigating from one side to the other of a real-world problem-field.
How-to guides describe how to do accomplish some goal.
Detailed (How-to)
Instructions:
- Add extra sections with step-by-step directions
- Avoid implementation specific details (programming language or framework -specific)
Further reading
Instructions:
- Provide links to external sources
- Don’t keep the link below or these instructions, they’re for your reference as the author
- Read about guides in the Diátaxis framework