Let's start with the basics! Below are some key concepts to keep in mind when creating documentation.
ABC
Audience Before Content. Consider the audience and the types of people who will be consuming your document. What are their needs, and what do they care about?
Someone on your team might require a lot more detail versus someone from another part of the business that just wants the highlights (but does need more context).
Make it stand out
Nothing scares people as much as a wall of text. Make use of the different elements that Slite offers out of the box. You can use "/" to explore, and consider adding /hint for summaries or /sketch to explain more complex flows in a visual way.
This sketch cannot currently be displayed in exports
Create a logical flow
The content of your doc should flow smoothly guiding the reader strategically through the content of your doc.
Add an intro at the top of the doc,
Use bullet points,
Start with the most important information at the top,
And have more detail in the body of the doc.
Use subheadings to break up content
Subheadings tell a story, they inform you the user in a matter of seconds what the doc is about. They break up the text and will be used to form the table of contents.
Headings (H1, H2, H3, H4) should be used to indicate the importance of a heading on the page. They should not be used stylistically to make text bigger or smaller. You can use colours, or make text bold if you want something to stand out.
Use the above-the-fold rule
Aim to make the main value point of your doc readable without the user having to scroll through the doc.