3 ms·
All good advice! As a dev, one area I find I lack in is writing technical descriptions for less technical audiences. Does anyone have advice for that specific
by elicksaur 3y ago
All good advice!
As a dev, one area I find I lack in is writing technical descriptions for less technical audiences. Does anyone have advice for that specific scenario?
e.g. explaining a bug and what’s needed to fix it, estimating level of effort for work, etc.
- mgaunard 3y agoJust make sure you explain every technical term or acronym before you use it.
- growingkittens 3y agoDepending on the scenario, here are some ideas: - Write the technical explanation first, then examine what concepts are required to reach the needed level of understanding. - Avoid loading multiple new terms or concepts into one sentence. - Introduce terms and their definitions as close together as possible. - Style the text of defined terms to differentiate them visually, the way textbooks bold key words, so the terms are easy to reference. - Make any introductory text easy to reference multiple times. - Lists of words and phrases are easier to reference if formatted as a list, not a sentence. - Lists with multiple dimensions, such as a list of terms and definitions, are easier to reference if formatted as a table.