{"product_id":"technical-documentation-best-practices-planning-and-structuring-helpful-user-assistance-contents-structure-user-navigation-9783943860122","title":"Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance: Contents, Structure, User Navigation","description":"\u003cp\u003eEven 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.\u003c\/p\u003e\u003cp\u003eThis book tells you how to structure, index, and link your documents so that readers actually find the information they need.\u003c\/p\u003e\u003cp\u003e\u003cbr\u003e\u003c\/p\u003e\u003cp\u003eTopics covered: \u003c\/p\u003e\u003cul\u003e\n\u003cli\u003e\n\u003cstrong\u003eGeneral structuring principles\u003c\/strong\u003e that all structural decisions have in common.\u003c\/li\u003e\n\u003cli\u003e\n\u003cstrong\u003eChoosing media: \u003c\/strong\u003e 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?\u003c\/li\u003e\n\u003cli\u003e\n\u003cstrong\u003ePlanning documents: \u003c\/strong\u003e 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?\u003c\/li\u003e\n\u003cli\u003e\n\u003cstrong\u003ePlanning document sections: \u003c\/strong\u003e What are the major sections that your documents should consist of? Are there any standard sections that you mustn't forget?\u003c\/li\u003e\n\u003cli\u003e\n\u003cstrong\u003ePlanning topics: \u003c\/strong\u003e What types of information do your clients need? How should you build and name the individual topics within the document?\u003c\/li\u003e\n\u003cli\u003e\n\u003cstrong\u003ePlanning the order of sections and topics: \u003c\/strong\u003e How should you organize the sections and topics within your documents? What comes first? What comes later?\u003c\/li\u003e\n\u003cli\u003e\n\u003cstrong\u003ePlanning navigation: \u003c\/strong\u003e 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?\u003cbr\u003e\n\u003c\/li\u003e\n\u003c\/ul\u003e","brand":"Indoition Publishing E.K.","offers":[{"title":"Default Title","offer_id":50671487811858,"sku":"9783943860122","price":28.99,"currency_code":"USD","in_stock":true}],"thumbnail_url":"\/\/cdn.shopify.com\/s\/files\/1\/0831\/4771\/8930\/files\/img_0689b293-27ef-40b2-8cb5-ec39cdd80710.jpg?v=1737244637","url":"https:\/\/surprise-castle.myshopify.com\/products\/technical-documentation-best-practices-planning-and-structuring-helpful-user-assistance-contents-structure-user-navigation-9783943860122","provider":"Surprise Castle","version":"1.0","type":"link"}