Aim for a product that needs no explanation, then write help for the cases where that is impossible.
Heuristic · Nielsen heuristics
Tag
documentation
Entries tagged documentation, drawn from across the library. Tags cut through the section structure, which is where most of the useful connections are.
11 entries across 5 sections
Type
Category
Level
11 entries
Once you know how something works you cannot accurately imagine not knowing, which is why teams misjudge their own interfaces.
Cognitive bias · Judgement
Users start acting immediately rather than reading, even when reading would be faster, so design has to teach through doing.
Psychology · Learning
Documentation is the product. An undocumented system is a component library nobody can adopt correctly.
Design system · Practice
Drafting component documentation from code, which handles the mechanical parts and not the judgement.
AI workflow · Design systems
A large share of searches returned nothing, and the fix was vocabulary rather than the search engine.
Case study · Search
Long-established tool for complex, data-driven prototypes and detailed specifications.
Tool · prototyping
The standard workshop for developing and documenting components in isolation.
Tool · design-systems
Design system documentation aimed at the whole team, not only engineers.
Tool · design-systems
Flexible documents and databases, used by many teams as a lightweight research repository.
Tool · collaboration
Enterprise documentation, usually chosen because the organisation already runs Jira.
Tool · collaboration