Whether technical information is easy to understand depends mainly on how it is presented at the level of small structures such as words and sentences. It can also involve larger structures such as examples and scenarios.

Aspects

Clarity: Freedom from ambiguity or obscurity; the presentation of information in such a way that users understand it the first time.
Concreteness: The inclusion of appropriate examples, scenarios, similes, analogies, specific language, and graphics.
Style: Correctness and appropriateness of writing conventions and of words and phrases.

References

Source: Developing Quality Technical Information (Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, Elizabeth Wilde)

quality

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Aspects

References

About

Keep up-to-date!

Powered by