Archive for the ‘Documentation’ Category

My First Video Movie on Technical Writing

November 29, 2010

Xtranormal.com is a website that gives an option to convert your text into a movie, that too free of cost(ok, ok)..You just need to choose your actors(max 2) and type your script, the site will take care of camera shots and recording. I have created a movie on the multiple roles that Technical Writers play in a development environment. Here is the link:

http://www.xtranormal.com/watch/7859593

Note: You can embed the video directly by publishing it in YouTube.

Advertisements

Have you ever read policy documents..?

August 27, 2010

Today morning I was quite busy in exploring an application. I got a phone call from an unknown number. I knew that it will be another credit card or Health Insurance representative’s call.  I always give a polite refusal and thank for their time in calling my number. Of course they are doing their job for their bread and butter.

This time also it was a Health Insurance plan from a Bank where I am paying my annual Insurance amount (ULIP). So no wonder they already had all my personal information (except my T-shirt size) and this guy very cleverly took my attention. Half mindedly I agreed to lend my ears to listen his available plans. But I didn’t agree to go ahead. I just convinced him that I will consider his plans after some months.

Un tired by my response, he asked me to give a look at their website to understand those health plans. I knew that site already, as twice a week I check out their site to see my Equity bonds value has grown or not. 🙂

This time, I clicked onother tab – Health Plans in their site.

After reading all those plans, I stopped for a while. Reason is quite simple. I saw an Insurance act 1938 Section 41 which goes as below:

Section 41 of Insurance Act 1938 states: No person shall allow or offer to allow, either directly or indirectly, as an inducement to any person to take out or renew or continue an insurance in respect of any kind of risk relating to lives or property in India, any rebate of the whole or part of the commission payable or any rebate of the premium shown on the policy, nor shall any person taking out or renewing or continuing a policy accept any rebate, except such rebates as may be allowed in accordance with the published prospectuses or tables of the insurer.

Non-Disclosure:

Section 45 of Insurance Act, 1938 states:

No Policy of life insurance effected before the commencement of this Act shall after the expiry of two years from the date of commencement of this Act and no policy of life insurance effected after the coming into force of this Act shall, after the expiry of two years from the date on which it was effected, be called in question by an insurer on the ground that a statement made in the proposal for insurance or in any report of a medical officer, or referee, or friend of the insured, or in any other document leading to the issue of the policy, was inaccurate or false, unless the insurer shows that such statement was on a material matter or suppressed facts which it was material to disclose and that it was fraudulently made by the policy-holder and that the policy holder knew at the time of making it that the statement was false or that it suppressed facts which it was material to disclose;

Provided that nothing in this section shall prevent the insurer from calling for proof of age at any time if he is entitled to do so, and no policy shall be deemed to be called in question merely because the terms of the policy are adjusted on subsequent proof that the age of the life insured was incorrectly stated in the proposal.

Can anyone understand these sections 41 and 45 on first read and explain it in plain English..?

Section 41 has 101 words in a single paragraph with only one full stop whereas section 45 has 227 words with one full stop.  

  • Why all policy documents (govt, health, Land, bank loans and so on) are not in plain language..?
  • Why does the writer (?) complicate the paragraphs this much..? First of all will he/she understand whatever he writes like this..?

In the UK, there is a separate campaign demanding all policy documents in plain English. I have already mentioned about that website in my previous post.

By the way, I am still trying to rephrase these sections 41 and 45. Anybody interested..? 🙂

My First Prezi on DDLC

July 30, 2010

Vodpod videos no longer available.

My First Prezi on DDLC, posted with vodpod

 

I created my first Prezi on Document Development Life Cycle(DDLC). I feel still there are enough rooms to enhance my prezi. Maybe I will groom much better in my next attempt.  I am curious to know your feedbacks and critics.

All about Technical Documentation

December 31, 2009

  1. Are you curious to know about technical documentation?
  2. Are you planning to begin your career in TW area?
  3. Do you have any plans in changing lanes from your development or academic field to TW area?

If the answer is YES for all the above questions, then you must check this website.  In this site, you can find some basic know-how, checklists, tools and links, which will help you to write create clear and concise user-friendly manuals, online help files, software demos, tutorials and other forms of user assistance.

There is a huge list of useful software, useful websites too. Hope you will like it.

I wish you all a happy NEW YEAR 2010 and may this year brings all happiness and prosperous in everybody’s life.

Documentation – Still a least cared area…?

November 9, 2009

 

I am a frequent visitor of Tom’s space. Last week when I was reading his post on wiki, few thoughts provoked me to update my space too. There is a unanimous belief among TWs’ is that Documentation is the least cared area and hardly very few project managers concern about the documentation while releasing a product. More or less it’s a fact too.

Though TWs’ took active participation in requirement analysis, UI designing, even QA testing, still documentation is considered as a grey area. I am really curious to know what will happen if any one ships their product without any documentation (includes both online and printed manuals)..? What will be the customer’s reaction on that product..?  It may sound funny or even weird, but I mean it.

Jeff has given a reply on my above comment at Tom’s space as follows:

I just read about a product that shipped without documentation – it’s called Fitbit, and in multiple reviews the reviewers complained that they couldn’t figure out how to use it and that there was no documentation.

See http://www.engadget.com/2009/10/15/fitbit-review/   for example.

Excerpt: “…shame that wasn’t in the manual. That’s because no manual comes with the thing, the implication being you just throw it on and go to town. Again that’s not quite the reality, especially when it comes to sleep.”

Thanks for this link Jeff.

On the other side of a coin, rarely we give feedbacks in our daily life. In any websites or help sections, there is a separate comment section for customer feedback.

Do we really like to drop a line over there..?

To be honest, I admit that I hardly give feedback. So, even I am not doing any justice to documentation, how could I expect a fair justice from others..? Hope I will change gradually.


%d bloggers like this: