Speaker: Tim Rogers
Writing great "getting started" documentation
Tim started out with a reference documentation (comprehensive and up to date) and a few blog posts to go along with it. And still people asked how to get started, and how to do the most simple things. Since documentarians are meant to be advocates for users, and find out what leads to users struggling.
- Who am I writing for? What do they want to achieve? What are their goals and struggles? (Personas, user groups, use cases, etc – you can keep segmenting more and more later on)
- What do I want to tell them about? (Bring them to the Magic Moment/Eureka Moment/…, showing the value the product supplies. Users who maintain magic moments will stay much longer with the product.)
"Getting started" documentation is very much required.
Reference docs are not enough
Build a linear experience for in your guides
- Introduce key concepts: Not all of them, naturally, and introduce them gradually where and when needed.
- Hand-holding through first steps: Make your user feel safe by making them feel like they understand the system
- End with a summary, and a link to the next section.
- Include best practices both as concepts and by example.
- Test with real beginners.
- Integrate your docs with your product: Offer links to documentation a lot, embedded as first-class citizens
- Simplify aggressively
Also, do not neglect your reference docs but accept that users have different needs. And don't forget that your docs are incomplete without a Getting Started guide.