3 ms·
I write English documentation about German bureaucracy. I must use German terms because it’s what people will encounter in the wild. Using one specific term con
by nicbou 4y ago
I write English documentation about German bureaucracy. I must use German terms because it’s what people will encounter in the wild. Using one specific term consistently affords us precision and unambiguity. It’s unavoidable.
I also can’t repeat the basics on every page. It would distract from the main topic of the page. I can’t teach you everything again on every page, for brevity’s sake.
I borrowed a solution from Wikipedia: popup word definitions. Click a word and get an explanation of what it is. You can keep reading if you know the concept, or click a word to know more.
I also borrowed “read more” links from the NHS. They link to a completely separate but related set of instructions. Wikipedia also does this when a subsection expands into its own entry.
Inclusiveness is achievable with a bit of design. Good documentation is as much about structure as it is about text.