Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance: Contents, Structure,...

— —

Marc Achtelig

Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance

Contents, Structure, User Navigation

Marc Achtelig

$42.95 $36.47

Paperback

Not in-store but you can order this
How long will it take?

Availability Information

We source books from suppliers in Australia and overseas. For books we don't currently have in stock, the time it takes to get them from our suppliers can vary widely - from a few days to a few months - so we check each book with each supplier to determine the expected time it will take to be supplied to us.

We then advise you accordingly. If the time taken to get any book is too long for you, you can let us know and we will cancel or adjust your order, and refund as required.

To find out the anticipated arrival time for specific items prior to ordering, please contact us by phone or email:

Phone +61 2 9264 3111, or 1800 4 BOOKS (1800 4 26657) if outside Sydney:
option 1 Abbey's Bookshop (Crime, History, Science, Kids & more) • info@abbeys.com.au
option 2 Language Book Centre (ESL & Foreign Languages) • language@abbeys.com.au
option 3 Galaxy Bookshop (Sci-fi, Fantasy, Romance, Graphic Novels) • sf@galaxybooks.com.au

QTY:

English

Indoition Publishing E.K.
25 October 2020

Technical writing; Technology: general issues; Computing: general; Computer programming & software development

Series: Technical Documentation Best Practices

Summary
Details

Even the best information is worthless if users can't find it. Providing user-friendly structure and navigation is just as important as providing well-written content. However, structuring user assistance isn't as simple and obvious as it may seem. If you think that your document structure should follow the structure of your product's components and functions: You're wrong. If you think that the type of document that you prefer is the same type of document that your clients prefer: You're wrong. If you think that all the information that you have is important: You're also wrong.

This book tells you how to structure, index, and link your documents so that readers actually find the information they need.

Topics covered:

General structuring principles that all structural decisions have in common. Choosing media:

Should you provide a printed or printable user manual (PDF), online help, or both? What information should go into the user manual, and what information should go into online help? Which help format should you use? Can context-sensitive help calls be implemented? Should you provide interactive features? Planning documents:

Should you put all information into one document, or should you supply several user manuals for specific purposes and user groups? How should you name your documents? Planning document sections:

What are the major sections that your documents should consist of? Are there any standard sections that you mustn't forget? Planning topics:

What types of information do your clients need? How should you build and name the individual topics within the document? Planning the order of sections and topics:

How should you organize the sections and topics within your documents? What comes first? What comes later? Planning navigation:

Which navigational devices should you provide in printed documents and in online help systems? Where should you provide links or cross-references and where not?

By: Marc Achtelig
Imprint: Indoition Publishing E.K.
Dimensions: Height: 229mm, Width: 152mm, Spine: 9mm
Weight: 240g
ISBN: 9783943860122
ISBN 10: 3943860124
Series: Technical Documentation Best Practices
Pages: 174
Publication Date: 25 October 2020
Audience: General/trade , ELT Advanced
Format: Paperback
Publisher's Status: Active