Sign-In
Cart
Technical Documentation Best Practices - Writing Clear and Helpful User Assistance: Writing Rules, Tips, FAQ
Paperback
Series: Technical Documentation Best Practices
Technology & EngineeringGeneral ComputersIllustration
Publisher Price: $49.00
ISBN13: 9783943860146
Publisher: Lightning Source Inc
Published: Oct 25 2020
Pages: 348
Weight: 1.03
Height: 0.72 Width: 6.00 Depth: 9.00
Language: English
Users want manuals that are easy to read, with short sentences, simple words, and unambiguous instructions. Unfortunately, writing plain language is much more difficult than writing overblown instructions that only an expert can understand. Writing complex texts is simple-writing simple texts is complex.
This book shows you how to write simple user assistance rather than complex user annoyance. As it's a book about stating your message clearly, it also states its own messages clearly. It's free of boring theory and free of highbrow grammar terms, but gives you clear recommendations and catchy examples that you can easily remember and apply to your own work.
Topics covered:
- General technical writing principles that make your texts plain, simple, and easy to understand.
- On the topic level: Rules for writing Concept topics, Task topics, and Reference topics.
- On the paragraph level: Rules for writing the standard elements that form a topic, such as headings, subheadings, procedures, lists, tables, warnings, notes, tips, examples, cross-references, and links.
- On the sentence level: Rules for building plain and unambiguous sentences.
- On the word level: Recommendations for using simple words.
- Spelling and punctuation FAQ.
- Grammar and word choice FAQ.
- Standard terms and phrases.
3 different editions
Also available
Also in
Illustration
Herve Tullet's Art of Play: Images and Inspirations from a Life of Radical Creativity
Tullet, Herve
Van Der Linden, Sophie
Hardcover
Roses in Bloom Puzzle: A 1000-Piece Jigsaw Puzzle Featuring Rare Art from the New York Botanical Garden: Jigsaw Puzzles for Adults
The New York Botanical Garden
Other
Living in the Deep End: 59 Things I've Learned About How to Have a Great Time Here
Yellin, Jackie
Hardcover
Botanicum Coloring Book: Hardcover Adult Coloring Book Featuring Thick, High-Quality Paper
Trolle, Maria
Hardcover
Fashion Sketchbook Female Figure Template: Over 200 female fashion figure templates in 10 different poses
Studio, Bye Bye
Paperback
The World of Jane Austen: A Conversation Puzzle: 500-Piece Puzzle: Jigsaw Puzzle for Adults
Oakley, Jacqui
Other
Simple Large Print Coloring Book for Seniors: Beautiful Designs for Adults, Seniors, and Beginners with Landscape, Nature, Flowers, Sweets (Bold & Eas
Publishing, Large Print Coloring Books
Paperback
Graphic Design for Everyone: Understand the Building Blocks So You Can Do It Yourself
Caldwell, Cath
Hardcover
Boisterous Beasts & Deadly Dragons: The Art of Nico Marlet
Miller-Zarneke, Tracey
Serrand, Kristof
Hardcover
Codices Illustres. the World's Most Famous Illuminated Manuscripts 400 to 1600
Wolf, Norbert
Walther, Ingo F.
Hardcover
How to Draw Sci-Fi Fantasy Mecha: Spaceships, Airplanes, Cars, Submarines and More! (Over 450 Illustrations)
Yoshimura, Shin
Somemori, Kenichi
Paperback
An Illustrated Catalog of American Mushrooms
Us Department of Agriculture Maurice B Walters Collection
Hardcover
The Walt Disney Film Archives. the Animated Movies 1921-1968. 45th Ed.
Kothenschulte, Daniel
Hardcover
20 Ways to Draw a Tulip and 44 Other Fabulous Flowers: A Sketchbook for Artists, Designers, and Doodlers
Congdon, Lisa
Paperback
Drawing Dimension - Shading Techniques: A Shading Guide for Teachers and Students
Holmes, Catherine V.
Paperback
An Illustrated Catalog of American Fruits & Nuts
Us Department of Agriculture Pomological Watercolor Collecti
Hardcover
Graphic Design Rules: 365 Essential Design DOS and Don'ts
Adams, Sean
Dawson, Peter
Seddon, Tony
Paperback
Street Art & Graffiti Atlas: 85+ Essential Artists from Around the World
López Giménez, Diego
Hardcover
William Blake. Dante's 'Divine Comedy'. the Complete Drawings
Schütze, Sebastian
Terzoli, Maria Antonietta
Hardcover
Drawing People: The Quick and Easy Way to Draw Faces, Figures, and More
Holmes, Catherine V.
Paperback
How to Draw Cool Stuff: Basic, Shading, Textures and Optical Illusions
Holmes, Catherine V.
Paperback
Visual Thinking: Empowering People and Organisations Through Visual Collaboration
Brand, Williemien
Paperback
The Illustrator's Guide: How to create an exceptional freelance illustration career
Hughes, James
Paperback
Observational Sketching: Hone Your Artistic Skills by Learning How to Observe and Sketch Everyday Objects
Higaki, Mariko
Paperback
101 Super Cute Things to Draw: More Than 100 Step-By-Step Lessons for Making Cute, Expressive, Fun Art!
Bergstrom, Lauren
Paperback