1
0
Fork 0

fix(docs): Update Guides documentation 2

This commit is contained in:
Benjamin F 2022-12-25 21:13:48 -08:00
parent d0415b33a5
commit 7cb6f11882
31 changed files with 81 additions and 81 deletions

View file

@ -2,9 +2,9 @@
title: How we structure our documentation
---
Whether you're writing documenation for FreeSewing, or merely trying
Whether you're writing documentation for FreeSewing or merely trying
to find what you are looking for, understanding how we structure our
documentation can help you find your feet, and figure out what goes where.
documentation can help you find your feet and figure out what goes where.
## Types of documentation
@ -16,7 +16,7 @@ Our documentation is divided into four different types:
- [**Reference**](/reference) holds technical descriptions of the underlying technology and how to make use of it.
Each time you write documentation, you have to ask yourself: Is it a tutorial? Is it a Guide?
Is it a Howto? Or is it Reference documentation.
Is it a Howto? Or, is it Reference documentation?
If you find it hard to answer that question, the illustration below might help you figure out
where your documentation should go based on what it's trying to accomplish:
@ -26,9 +26,9 @@ structure](docs.png "A visual representation of how our documentation is structu
- Write a **Tutorial** is your aim is to help people learn the platform
- Write a **Guide** if your aim is to further people's understanding of a topic by going a bit deeper
- Write a **Howto** if your ain is to help people accomplish a task
- Write a **Howto** if your aim is to help people accomplish a task
- Write **Reference** documentation to detail how things work under the hood
- Refer people to **Discord or Github** for things that are not (yet) covered in our documentation
- Refer people to **Discord** or **GitHub** for things that are not (yet) covered in our documentation
<Note>