Focus documentation on user goals and what they can accomplish, not just on describing interface elements.
Integrate documentation writing from the use case phase of development instead of treating it as an afterthought.
Use precise, neutral, and inclusive language to create a welcoming environment and avoid problematic terms like master/slave or gendered pronouns.
Replace patronizing words like 'simply' or 'easy' with specific, comparative, or absolute descriptions to avoid frustrating users.
Avoid using humor which is hard to localize, and instead use plain language to make documentation more accessible and easier to read.
Address common user errors by explaining what happened, why it happened, and what the user should do next to resolve it.
Combat the curse of knowledge by explaining core concepts, avoiding assumptions, and providing a glossary for product-specific terms.
Improve code snippets by avoiding screenshots, using semantic HTML, enabling syntax highlighting, and replacing abstract placeholders with meaningful variable names.
Maintain clear documentation by adopting a consistent structure and being transparent about your product's limitations and ideal use cases.
Build trust and improve user experience by grounding your documentation in the core principles of being honest, helpful, and human.
Sensory-Minds GmbH
Offenbach am Main, Germany
28:39Eleftheria Batsou
31:23Hila Fish
56:01Dirk Ginader
25:25Luise Freese
27:01Marcel Bagemihl & Miriam Becker
20:19Anastasiia Tymoshchuk
26:15Gernot Starke & Benjamin Wolf
22:45Abiodun Olowode
Jobs that call for the skills explored in this talk.
M4 Digital Group Ltd
Waltham Abbey, United Kingdom
M4 Digital Group Ltd
Waltham Abbey, United Kingdom
