03.6.5 · Skill in Content design

Documentation UX

Help content that people can find and use while they work.

Documentation is part of the product experience. It needs structure, search, examples and maintenance. For developer products it is often the most visited part of the product.

Your status · Documentation UX

Not startedLearningComfortable

Saved in this browser only. It colours this skill's tile on your map.

Resources

docsStart here
Diátaxis ↗
Daniele Procida · free guide
Four kinds of documentation (tutorials, how-to guides, reference, explanation) and why mixing them fails.
articleStart here
Help and documentation (usability heuristic 10) ↗
NN/g · 2020 · 9 min
Proactive and reactive help, and how to keep it short and close to the task.

Tools

none yet

Tools for this topic are being researched.