Micro:bit 101 (testing the architecture & format for coding/electronics)
In this tutorial we will be going over best practices to ensure that documentation can be read and accessed by everyone.
Good documentation should always be
- Easy to Find
- Easy to Navigate
- Clear
- Accessible
Easy to Find
To make Documentation easy to find all documentation will be in a the Tutorial database. We will use tags to help organize. Tags will automatically be added depending on where documentation is created.
Add Tutorials to a Specific Page
Editing Properties & Adding Tags
Easy to Navigate
To make documentation easy to navigate, add a table of content on the top left of the page. Table of content allow users to have a clear idea what will be covered in the documentation and when. The also allows users to jump to the desired part of the page quickly. Setting text to a specific heading type will define what each section is about and how the table of content is structured. Toggles can be add to allow users to see
Formatting Table of Content
Creating Table of Contents
Clear
To make documentation clear it is important to communicate the goals of the documentation, what past knowledge is assumed and communicate content as a vivid story.
Goals and Assumptions
Story Telling
Accessible
To make documentation accessible keep in mind all possible audiences. This should include audience with accessibility needs as well as taking into consideration what platform they are using to read your documentation (such at desktop or cellphone).