Technical Documentation Short and Sweet
ISBN: 978-39-438-6015-3
Format: 15.2x22.9cm
Liczba stron: 334
Oprawa: Miękka
Wydanie: 2020 r.
Język: angielski
Dostępność: dostępny
<p>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.</p><p><br></p><p>Topics covered:</p><ul><li><strong>Structuring</strong> principles, including building topics, establishing headings, and determining the best possible order of information</li><li><strong>Layout</strong> and <strong>formatting</strong> essentials</li><li>General technical <strong>writing</strong> rules</li><li>Rules for building sections</li><li>Rules for building sentences</li><li>Plain language</li><li>Grammar and word choice FAQ</li><li>Creating <strong>images</strong> of hardware and software</li><li><strong>Video</strong> design</li></ul>