Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance
Home > Dictionaries & Language > Language: reference & general > Language: history & general works > Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance
Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance

Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance


     0     
5
4
3
2
1



International Edition


About the Book

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?


Best Sellers



Product Details
  • ISBN-13: 9783943860122
  • Publisher: Indoition Publishing E.K.
  • Publisher Imprint: Indoition Publishing E.K.
  • Height: 229 mm
  • No of Pages: 174
  • Series Title: Technical Documentation Best Practices
  • Sub Title: Contents, Structure, User Navigation
  • Width: 152 mm
  • ISBN-10: 3943860124
  • Publisher Date: 25 Oct 2020
  • Binding: Paperback
  • Language: English
  • Returnable: N
  • Spine Width: 9 mm
  • Weight: 290 gr


Similar Products

Add Photo
Add Photo

Customer Reviews

REVIEWS      0     
Click Here To Be The First to Review this Product
Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance
Indoition Publishing E.K. -
Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance
Writing guidlines
We want to publish your review, so please:
  • keep your review on the product. Review's that defame author's character will be rejected.
  • Keep your review focused on the product.
  • Avoid writing about customer service. contact us instead if you have issue requiring immediate attention.
  • Refrain from mentioning competitors or the specific price you paid for the product.
  • Do not include any personally identifiable information, such as full names.

Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance

Required fields are marked with *

Review Title*
Review
    Add Photo Add up to 6 photos
    Would you recommend this product to a friend?
    Tag this Book Read more
    Does your review contain spoilers?
    What type of reader best describes you?
    I agree to the terms & conditions
    You may receive emails regarding this submission. Any emails will include the ability to opt-out of future communications.

    CUSTOMER RATINGS AND REVIEWS AND QUESTIONS AND ANSWERS TERMS OF USE

    These Terms of Use govern your conduct associated with the Customer Ratings and Reviews and/or Questions and Answers service offered by Bookswagon (the "CRR Service").


    By submitting any content to Bookswagon, you guarantee that:
    • You are the sole author and owner of the intellectual property rights in the content;
    • All "moral rights" that you may have in such content have been voluntarily waived by you;
    • All content that you post is accurate;
    • You are at least 13 years old;
    • Use of the content you supply does not violate these Terms of Use and will not cause injury to any person or entity.
    You further agree that you may not submit any content:
    • That is known by you to be false, inaccurate or misleading;
    • That infringes any third party's copyright, patent, trademark, trade secret or other proprietary rights or rights of publicity or privacy;
    • That violates any law, statute, ordinance or regulation (including, but not limited to, those governing, consumer protection, unfair competition, anti-discrimination or false advertising);
    • That is, or may reasonably be considered to be, defamatory, libelous, hateful, racially or religiously biased or offensive, unlawfully threatening or unlawfully harassing to any individual, partnership or corporation;
    • For which you were compensated or granted any consideration by any unapproved third party;
    • That includes any information that references other websites, addresses, email addresses, contact information or phone numbers;
    • That contains any computer viruses, worms or other potentially damaging computer programs or files.
    You agree to indemnify and hold Bookswagon (and its officers, directors, agents, subsidiaries, joint ventures, employees and third-party service providers, including but not limited to Bazaarvoice, Inc.), harmless from all claims, demands, and damages (actual and consequential) of every kind and nature, known and unknown including reasonable attorneys' fees, arising out of a breach of your representations and warranties set forth above, or your violation of any law or the rights of a third party.


    For any content that you submit, you grant Bookswagon a perpetual, irrevocable, royalty-free, transferable right and license to use, copy, modify, delete in its entirety, adapt, publish, translate, create derivative works from and/or sell, transfer, and/or distribute such content and/or incorporate such content into any form, medium or technology throughout the world without compensation to you. Additionally,  Bookswagon may transfer or share any personal information that you submit with its third-party service providers, including but not limited to Bazaarvoice, Inc. in accordance with  Privacy Policy


    All content that you submit may be used at Bookswagon's sole discretion. Bookswagon reserves the right to change, condense, withhold publication, remove or delete any content on Bookswagon's website that Bookswagon deems, in its sole discretion, to violate the content guidelines or any other provision of these Terms of Use.  Bookswagon does not guarantee that you will have any recourse through Bookswagon to edit or delete any content you have submitted. Ratings and written comments are generally posted within two to four business days. However, Bookswagon reserves the right to remove or to refuse to post any submission to the extent authorized by law. You acknowledge that you, not Bookswagon, are responsible for the contents of your submission. None of the content that you submit shall be subject to any obligation of confidence on the part of Bookswagon, its agents, subsidiaries, affiliates, partners or third party service providers (including but not limited to Bazaarvoice, Inc.)and their respective directors, officers and employees.

    Accept

    New Arrivals



    Inspired by your browsing history


    Your review has been submitted!

    You've already reviewed this product!