Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance

Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance

Marc Achtelig

32,20 €
IVA incluido
Disponible
Editorial:
indoition publishing e.K.
Año de edición:
2020
ISBN:
9783943860122
32,20 €
IVA incluido
Disponible

Selecciona una librería:

  • Librería Samer Atenea
  • Librería Aciertas (Toledo)
  • Kálamo Books
  • Librería Perelló (Valencia)
  • Librería Elías (Asturias)
  • Donde los libros
  • Librería Kolima (Madrid)
  • Librería Proteo (Málaga)

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? 3

Artículos relacionados

  • Poetry Is Our Ministry to Touch the Heart
    Anelda Lukesia Ballard / Jean Anelda Scott
    Poetry is Our Ministry to Touch the Heart, was birthed when Anelda L. Ballard became ill. God spoke to her in a dream and said 'pick up a pen and write' by being obedient this book was written through the Holy Spirit. Anelda and her mother Jean A. Scott believes that God’s wants to heal a hurting heart. This book will inspire you and encourage you to never give up hope. Jesu...
    Disponible

    11,12 €

  • I soldati lunghi
    Pierluigi Romeo di Colloredo Mels
    Il 24 maggio 1915 il Regno d’Italia entrò nella Grande Guerra, che si sarebbe dimostrata il momento più alto e tragico della sua storia, a poco più di cinquant’anni dalla sua unificazione.In quella lotta tremenda durata quattro anni, la Brigata Granatieri di Sardegna , con i suoi due valorosi Reggimenti, i più antichi del Regio Esercito scrisse, nel grande quadro della guerra d...
    Disponible

    32,59 €

  • Five Beneath Philly
    Susan Bandy / Tom Richmond
    Allen Williams plans to make something of his life and escape South Philly and the work at Cross Brothers’ Meat Packing Plant. He prepares himself with excellent grades and an upcoming full-ride scholarship to climb out of South Philly forever. Then fate changes his whole world. An only son in a family of six, Allen suddenly finds himself responsible for his mother, grandmother...
    Disponible

    18,28 €

  • Forms
    Sharon Welch
    I am an award-winning artist and my works hang in private residences, community hospitals, businesses, and restaurants across the US and also abroad.  I live in Pierre, South Dakota. Since 2008 I have owned Sharon Welch Gallery and Studio where I paint and teach classes.  My theory is have fun, remove the fear of failure, experiment and let the child inside of you play.Very oft...
  • Ricordi di una ausiliaria
    Andrea Lombardi / Raffaella Duelli
    Le memorie di Raffaella Duelli, Volontaria nel Battaglione Barbarigo della Decima Flottiglia Mas iniziano con la partenza del Barbarigo da Roma, narrando la lunga marcia del reparto verso il nord, sotto il mitragliamento degli aerei Alleati. Quindi, è descritta vividamente l'ultima battaglia del Barbarigo sul Fronte Sud, dal Senio a Comacchio: gli appunti di Raffaella, giov...
    Disponible

    28,08 €

  • Why Didn’t You Ask?
    Panya Dixon
    From an early occurrence in her childhood to a perilous thirteen-year relationship, Panya Dixon too often suffered from various forms of physical, emotional, and sexual abuse. Conflicted between love and the pain her loved ones brought on her, she consistently had to fight for her life and her will to move on. Why Didn’t You Ask? is an expression of Panya’s truth—her trials, pa...
    Disponible

    20,35 €

Otros libros del autor

  • Technical Documentation Best Practices - Creating Effective Visualizations for Technical Communication
    Marc Achtelig
    Words are not always the best medium for communicating technical information. Sometimes, a picture, a simple animation, or a short video can intuitively show within a few seconds what words can hardly describe.However, there are also cases in which pictures are too complicated and videos are too slow in conveying information. For effective technical communication, images and vi...
    Disponible

    39,86 €

  • Best Practices Technische Dokumentation - Handbücher und Hilfen anschaulich illustrieren und animieren
    Marc Achtelig
    Worte sind nicht immer das beste Medium, um technische Informationen zu vermitteln. Manchmal können ein Bild, eine kleine Animation oder ein kurzes Video innerhalb weniger Sekunden intuitiv zeigen, was Worte kaum zu beschreiben vermögen.Dies gibt aber auch Fälle, in denen Bilder viel zu umständlich sind in der Informationsvermittlung und Videos viel zu langsam. Für eine effekti...
    Disponible

    39,76 €

  • Technical Documentation Best Practices - Visually Designing Modern Help Systems and Manuals
    Marc Achtelig
    Aesthetics isn’t the only thing that you should be striving for when desiging a user manual template or the style sheet of an online help system. When creating technical documentation, usability, readability, and simplicity are at least just as crucial.The design should please the eye, but at the same time it must communicate the content clearly. In addition, paragraph styles a...
    Disponible

    40,38 €

  • Technical Documentation Best Practices - Writing Clear and Helpful User Assistance
    Marc Achtelig
    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...
    Disponible

    39,83 €

  • Technical Documentation Short and Sweet
    Marc Achtelig
    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, ...
    Disponible

    47,42 €

  • Reihe Lösungen zur Technischen Dokumentation
    Marc Achtelig
    Benutzer wollen leicht lesbare Handbücher mit kurzen Sätzen, einfachen Wörtern und unmissverständlichen Anleitungen. Leider ist es wesentlich schwieriger eine einfache Anleitung zu schreiben als eine, die nur ein Experte versteht. Das Schreiben komplizierter Texte ist einfach - das Schreiben einfacher Texte ist kompliziert. Dieses Buch zeigt Ihnen, wie Sie einfache Texte schrei...
    Disponible

    73,86 €