{"id":86,"date":"2005-08-03T10:03:00","date_gmt":"2005-08-03T10:03:00","guid":{"rendered":"http:\/\/sumankumar.com\/blog\/?p=86"},"modified":"2005-08-03T10:03:00","modified_gmt":"2005-08-03T10:03:00","slug":"interactive-documentation","status":"publish","type":"post","link":"https:\/\/sumankumar.com\/blog\/2005\/08\/interactive-documentation\/","title":{"rendered":"Interactive Documentation"},"content":{"rendered":"

Novell has a ‘Comments’ feature on its product documentation pages<\/a>. User can leave their feedback instantly, instead of sending an E-mail later. (But why does the RSS link<\/a> fail on your site guys?)<\/p>\n

Microsoft too has an instant feedback feature <\/a> for its documentation, but somehow I don’t like it. It appears to be complex, as compared to Novell’s.
But I like PHP.net’s interactivity<\/a> the best. Don’t ask me why. It is just subjective I guess. <\/p>\n

Anyway, out of curiosity I went to Apple’s iPod site<\/a> (I own a Shuffle) and I discovered to my utter dismay the terrible feedback mechanism<\/a> they have. Gray text on gray background and they expect users to notice that ‘Provide Feedback’ link. Ambitious. I expected something better from Apple.<\/p>\n

\n\n\n<\/map>\n

<\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":"

Novell has a ‘Comments’ feature on its product documentation pages. User can leave their feedback instantly, instead of sending an E-mail later. (But why does the RSS link fail on your site guys?) Microsoft too has an instant feedback feature for its documentation, but somehow I don’t like it. It appears to be complex, as […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_uag_custom_page_level_css":"","advanced_seo_description":"","jetpack_seo_html_title":"","jetpack_seo_noindex":false,"ngg_post_thumbnail":0,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_post_was_ever_published":false},"categories":[1],"tags":[195],"class_list":["post-86","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-uncategorized"],"jetpack_featured_media_url":"","uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"jetpack-portfolio-admin-thumb":false},"uagb_author_info":{"display_name":"Suman Kumar","author_link":"https:\/\/sumankumar.com\/blog\/author\/suman-kumar\/"},"uagb_comment_info":0,"uagb_excerpt":"Novell has a ‘Comments’ feature on its product documentation pages. User can leave their feedback instantly, instead of sending an E-mail later. (But why does the RSS link fail on your site guys?) Microsoft too has an instant feedback feature for its documentation, but somehow I don’t like it. It appears to be complex, as…","jetpack_shortlink":"https:\/\/wp.me\/p2Gbk8-1o","jetpack_likes_enabled":false,"jetpack_sharing_enabled":true,"jetpack-related-posts":[{"id":92,"url":"https:\/\/sumankumar.com\/blog\/2005\/10\/top-ten-documentation-heuristics-by-vesa-purho\/","url_meta":{"origin":86,"position":0},"title":"Top Ten Documentation Heuristics by Vesa Purho","author":"Suman Kumar","date":"October 28, 2005","format":false,"excerpt":"\"For example, people working on a rooftop installing some hardware would not necessarily be delighted with nice multimedia CD-ROMs but prefer a laminated quick reference card.\" That statement pretty much sums it up for me. Read on! 1. Match between documentation and the real world The documentation should speak the\u2026","rel":"","context":"In \"Uncategorized\"","block_context":{"text":"Uncategorized","link":"https:\/\/sumankumar.com\/blog\/tag\/uncategorized\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":109,"url":"https:\/\/sumankumar.com\/blog\/2007\/03\/documentation-google-style\/","url_meta":{"origin":86,"position":1},"title":"Documentation: Google Style","author":"Suman Kumar","date":"March 3, 2007","format":false,"excerpt":"...now, it is not the video or the technology, but it is the informal tone, that will make users use that document. When will corporations understand this?Write to me: Sumank[at]gmail[dot]com","rel":"","context":"In \"google\"","block_context":{"text":"google","link":"https:\/\/sumankumar.com\/blog\/tag\/google\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":71,"url":"https:\/\/sumankumar.com\/blog\/2004\/10\/off-shoring-of-documentation-a-survey\/","url_meta":{"origin":86,"position":2},"title":"Off shoring of Documentation: a survey","author":"Suman Kumar","date":"October 7, 2004","format":false,"excerpt":"Today, many software product companies have a base in India. A huge pool of talent, low wages, and an English-speaking population made India a great outsourcing destination. In the past few years, technical writing too transitioned to India for the same aforementioned reasons. If you are a technical writer working\u2026","rel":"","context":"In \"Uncategorized\"","block_context":{"text":"Uncategorized","link":"https:\/\/sumankumar.com\/blog\/tag\/uncategorized\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":65,"url":"https:\/\/sumankumar.com\/blog\/2004\/07\/wanted-sr-technical-writer-for-informatica-corporation\/","url_meta":{"origin":86,"position":3},"title":"Wanted: Sr Technical Writer for Informatica Corporation","author":"Suman Kumar","date":"July 30, 2004","format":false,"excerpt":"Location: Bangalore Corporate Headquarters: Redwood City, CA Contact: Thao Diep, tdiep@informatica.com Job Description Responsible for writing documentation to support our PowerAnalyzer and PowerCenter Connect product lines. PowerAnalyzer is a business intelligence tool that helps decision makers access, analyze, and share enterprise data. PowerCenter Connect products enable integration to ERP systems\u2026","rel":"","context":"In \"Uncategorized\"","block_context":{"text":"Uncategorized","link":"https:\/\/sumankumar.com\/blog\/tag\/uncategorized\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":53,"url":"https:\/\/sumankumar.com\/blog\/2004\/04\/participative-help-design\/","url_meta":{"origin":86,"position":4},"title":"Participative Help Design","author":"Suman Kumar","date":"April 5, 2004","format":false,"excerpt":"Participative Help Design I used a weblog script to create online help for -uh- using weblogs. I used a plugin to pull help topics as alphabetical links. The script has in-built search. So, there, I had an index and a search. And I left the 'Comments' feature alone. And guess\u2026","rel":"","context":"In \"Uncategorized\"","block_context":{"text":"Uncategorized","link":"https:\/\/sumankumar.com\/blog\/tag\/uncategorized\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":64,"url":"https:\/\/sumankumar.com\/blog\/2004\/07\/style-guides-sacrosanct\/","url_meta":{"origin":86,"position":5},"title":"Style guides: Sacrosanct?","author":"Suman Kumar","date":"July 28, 2004","format":false,"excerpt":"How many times have you paused and reflected, \u2018man, I know I am right, but the style guide does not agree\u2026\u2019? For example, some style guides proscribe the use of the possessive pronoun noun (earlier I had written 'pronoun'. Thanks Guy for pointing it out.) and demand that you elaborate:\u2026","rel":"","context":"In \"Uncategorized\"","block_context":{"text":"Uncategorized","link":"https:\/\/sumankumar.com\/blog\/tag\/uncategorized\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/posts\/86","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/comments?post=86"}],"version-history":[{"count":0,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/posts\/86\/revisions"}],"wp:attachment":[{"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/media?parent=86"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/categories?post=86"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/tags?post=86"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}