Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance: Contents, Structure, User Navigation

Even the best information is worthless if users can't find it. Providing user-friendly structure and navigation is...
$76.57 SGD
$76.57 SGD
SKU: 9783943860122
Product Type: Books
Please hurry! Only 567 left in stock
Author: Marc Achtelig
Format: Paperback
Language: English
Subtotal: $76.57
10 customers are viewing this product
Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance: Contents, Structure, User Navigation by Achtelig, Marc

Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance: Contents, Structure, User Navigation

$76.57

Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance: Contents, Structure, User Navigation

$76.57
Author: Marc Achtelig
Format: Paperback
Language: English

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?

    Author: Marc Achtelig
    Publisher: Indoition Publishing E.K.
    Published: 10/25/2020
    Pages: 174
    Binding Type: Paperback
    Weight: 0.53lbs
    Size: 9.00h x 6.00w x 0.37d
    ISBN: 9783943860122

    This title is not returnable

Returns Policy

You may return most new, unopened items within 30 days of delivery for a full refund. We'll also pay the return shipping costs if the return is a result of our error (you received an incorrect or defective item, etc.).

You should expect to receive your refund within four weeks of giving your package to the return shipper, however, in many cases you will receive a refund more quickly. This time period includes the transit time for us to receive your return from the shipper (5 to 10 business days), the time it takes us to process your return once we receive it (3 to 5 business days), and the time it takes your bank to process our refund request (5 to 10 business days).

If you need to return an item, simply login to your account, view the order using the "Complete Orders" link under the My Account menu and click the Return Item(s) button. We'll notify you via e-mail of your refund once we've received and processed the returned item.

Shipping

We can ship to virtually any address in the world. Note that there are restrictions on some products, and some products cannot be shipped to international destinations.

When you place an order, we will estimate shipping and delivery dates for you based on the availability of your items and the shipping options you choose. Depending on the shipping provider you choose, shipping date estimates may appear on the shipping quotes page.

Please also note that the shipping rates for many items we sell are weight-based. The weight of any such item can be found on its detail page. To reflect the policies of the shipping companies we use, all weights will be rounded up to the next full pound.

Related Products

Recently Viewed Products