Home » Blogs » vinehaish's blog

User Feedback and Comments on Technical Documentation

Submitted by vinehaish on Wed, 06/20/2012 - 09:36
Printer-friendly versionPrinter-friendly version

Till few years back, the primary objective of technical documentation was to present the procedures and instructions clearly and accurately. I wonder if on one of those fine sunny days in December, I should have asked my documentation manager, Seema “Shall I ask the user if my instructions are clear, and that the information on that page was useful or not?”

It is not difficult to guess how she would have responded. May be as “What does that mean? Why we should assume that user will say NO, that the information on page was not useful. Do we not trust our documentation skills?”

But it was many years back.

Today, I see that many online knowledgebase systems have this option to ask users whether the information was useful or not.

Read the full post at: http://enjoytechnicalwriting.com/2012/06/20/user-comments-and-feedback-on-technical-documentation/

BR
- Vinish

Bookmark/Search this post with
»

Post new comment

The content of this field is kept private and will not be shown publicly.
  • Allowed HTML tags: <a> <em> <strong> <style> <span> <cite> <class> <div> <code> <ul> <ol> <li> <dl> <dt> <dd> <p> <b> <i> <u> <s> <color> <img> <td> <tr> <font> <basefont> <table> <p> <br> <th> <ins> <h1> <h2> <h3> <h4> <h5> <h6>
  • You can use BBCode tags in the text. URLs will automatically be converted to links.
  • Lines and paragraphs break automatically.

More information about formatting options

CAPTCHA
This question is for testing whether you are a human visitor and to prevent automated spam submissions.
ten * = 20
Solve this math question and enter the solution with digits. E.g. for "two plus four = ?" enter "6".
By submitting this form, you accept the Mollom privacy policy.