This blog post is dedicated to help you take steady steps in our documentation section. In here, we'll talk you through our multiple documentation components and tell you when you should use each!
Diátaxis
We've based our documentation structure on the Diátaxis framework.
Diátaxis is a systematic framework for technical documentation writing that aims to solve problems concerning the structure in technical documentation through a systematic approach of understanding the needs of users in the normal cycle of interaction with a product. In our case, the Tamra IoT platform.
Diátaxis defines four modes of documentation:
- Tutorials
- How-To-Guides
- Technical Reference
- Explanation
And in Diátaxis, each mode fulfils a specific user need, and therefore, has a different approach.
You can visit Diátaxis for more information.
Tutorials
Tutorials are learning-oriented. They're designed to help beginners achieve basic competence with working with the Tamra platform, so that they can continue to create their own projects using it. In other words, you don't need to know much before you start going through our tutorials.
Tutorials are the first basic lessons you can use to build up your practical knowledge. They turn you from a new learner into a user and you learn by doing.
How-To-Guides
How-to-guides are basic directions you follow to solve a particular problem, so they're considered goal-oriented.
They're kind of like recipes that guide you throguh the steps to achieve a certain goal like: how to create a new account, how to reset your password, how to edit port settings, etc.
You mainly use the how-to-guides when you have a specific issue that you want an answer to. If you visit our how-to-guides section, you'll find that it's divided into how-tos concerning our application and how-tos concerning wifi connections to make it easier for you to find the solution to your problem.
Reference
Reference guides are where you can learn more technical descriptions and the operating methods of things. It's an information-oriented section.
In the reference section, you find descriptions of things that may confuse you while, for example, going through a tutorial, explained in detail.
You can find information about things like the composition of the hardware or the powering methods of the Tamra board.
And that concludes our Documentation structure and when to use each section!