Part 2: Easy to use
Users access technical information to accomplish a goal, which typically involves doing one or more tasks. Technical information should make it easy for users to successfully achieve their goals. It should be trustworthy. Users should have all of the information they need without being overloaded with extraneous information.
Write for the intended audience
Present information from the users’ point of view
Identify tasks that support users’ goals
Write user-oriented task topics, not function-oriented task topics
Get Developing Quality Technical Information: A Handbook for Writers and Editors, Third Edition now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
