Technical Documentation Basics

Do you need to write some technical documentation? Do you want to do a good job but don’t have much time that you can spend? The book provides hands-on advice and simple, catchy examples—free from theoretical elaborations and highbrow grammar terms.

Technical Documentation Basics

Browse through book (preview)

open preview

Note:  The original book has significantly more pages than this preview. Anyhow, this preview is very liberal. If you like the book and actually read larger sections, please be fair and buy a copy. Thank you.

Achtelig, Marc
Technical Documentation Basics:
“How to Write That F***ing Manual” — The essentials of technical writing in a nutshell

Approx. 208 pages; ISBN 978-3-943860-00-9
Also available as an ebook here

 

 

Are you a developer, marketing professional, or product manager and need to create some user assistance for your product? Do you want to make your user manual and online help system 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 rules that really matter. If you follow the given recommendations, this will significantly improve the quality of what you write, all with the least amount of effort.

You get hands-on advice and simple, catchy examples—free from theoretical elaborations and highbrow grammar terms.

The book is exemplary for what you need to achieve, too. It contains lots of valuable 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