Tuesday, September 27, 2011

Doc or No Doc, that is the question.

Doc is short for documentation. For most programmers it is not something we want to do are will do. Well then why not?

Let's look at what documentation is from MIT they say: "The formal description of a mechanical system or a technical process is known as its documentation. Documentation takes the form of technical and user manuals that accompany various technological objects, materials, and processes. Electronic hardware, computers, chemicals, automobiles all are accompanied by descriptive documentation in the form of manuals." Then they go to state that there are two types of documentation: user and technical.

There is another type, or sub-type if you will, that showing up all over. You will see as an installation manual with lots of pictures a very few words. It the equivalent of child's picture book. Yes, we have digressed to be very non-technical and show the user or technical person how to do something with screen captures and as few words as possible.  But if that works so be it.

What it still surprising is that no reads or even looks for the the documentation if you create it.  Even if it is the sub-type as described above, they do not look at.  Maybe that is why in today's editors have documentation as you type because most do read the manual.

Next time read the frigging manual and see what it has to say.  You might learn something after all.

No comments:

Post a Comment