Explore the latest books of this year!
Bookbot

Technical Documentation Short and Sweet

The Best Best Practices for Creating Clear and Useful Manuals, Help Systems, and Other Forms of User Assistance

Parameters

  • 334 pages
  • 12 hours of reading

More about the book

Do you want to make the user manuals or online help systems of your products stand out from those of your competitors but don't have the time to study a dozen all-embracing textbooks about technical writing before getting down to work? This book provides you with a compilation of those best practices that are going to make a real difference. You get hands-on advice and simple, catchy examples-free from theoretical elaborations, highbrow grammar terms, and other shoptalk. The book is exemplary for what you need to achieve as well: deliver the essential information on as few pages as possible in a clear and simple form. Topics covered: Structuring principles, including building topics, establishing headings, and determining the best possible order of information Layout and formatting essentials General technical writing rules Rules for building sections Rules for building sentences Plain language Grammar and word choice FAQ Creating images of hardware and software Video design

Book purchase

Technical Documentation Short and Sweet, Marc Achtelig

Language
Released
2020
product-detail.submit-box.info.binding
(Paperback)
We’ll email you as soon as we track it down.

Payment methods

No one has rated yet.Add rating

Title
Technical Documentation Short and Sweet
Subtitle
The Best Best Practices for Creating Clear and Useful Manuals, Help Systems, and Other Forms of User Assistance
Language
English
Released
2020
Format
Paperback
Pages
334
ISBN10
3943860159
ISBN13
9783943860153
Series
Description
Do you want to make the user manuals or online help systems of your products stand out from those of your competitors but don't have the time to study a dozen all-embracing textbooks about technical writing before getting down to work? This book provides you with a compilation of those best practices that are going to make a real difference. You get hands-on advice and simple, catchy examples-free from theoretical elaborations, highbrow grammar terms, and other shoptalk. The book is exemplary for what you need to achieve as well: deliver the essential information on as few pages as possible in a clear and simple form. Topics covered: Structuring principles, including building topics, establishing headings, and determining the best possible order of information Layout and formatting essentials General technical writing rules Rules for building sections Rules for building sentences Plain language Grammar and word choice FAQ Creating images of hardware and software Video design