Tutorials and series
How to write a tutorial in Community: markdown, a cover, tags, a reading time and a series name and part number so parts stay together.
Tutorial channels (How-tos on Users, Tutorials on Developers) take long-form posts.
What a tutorial has#
Markdown, a cover, up to five tags, a reading time worked out from the text, and optionally a series: a name and a part number.
A series#
Give each part the same series name and its own number. Readers see the parts together. The team's first series is Building on the registry, whose first part plugs an app into Geenius OS in five steps.
A shape that works#
- Say what the reader will have at the end.
- One step per heading.
- Show the command or the result, then explain it.
- End with where to ask.
Showcase#
Showcase channels (What I made, Built on Geenius) take a cover too. Say what it is and how you made it.