Tuesday, May 24, 2005

Not used properly, templates can do more harm than good.

There are at least two things that typically go into a template: Look and content structure. The look is the visual style like the fonts, the front page design, top and bottom texts and these sorts of things. This is what you should use your templates for. This is very useful. It makes all documents have the same familiar look. You can also include a table where you can type the author's name and the creation date, and a table for version history. These are things that won't interfere with writing the content of the document.

The second thing that is typically put into a template is content structure. By this I mean the predefined set of information that the document is meant to contain, and how to structure it. Like the long list of detailed section headlines, the description of each headline and the pre-written texts that is there to help writers so they don't have to write it themselves.

This content structure is the part I consider can do more harm than good. It is meant to help writers make consistent documentation that is sure to include all the parts that should be in there. But it is actually discouraging developers from thinking. Thinking about how to communicate by the document. It is reducing the process of writing into a fill-in-the-blanks excercise where the writer won't need to think outside of the helpful description for the particular section he is about to fill in.

By intention and not only by letter

So why is that a bad thing? Well, a technical document should help the reader to understand your thought process and your conclusions, the problem you are solving, how it will be solved, and why it was solved that way. Only with this information can another person really understand the technical decisions that the document describes, and implement the specification by intention and not only by letter. This kind of communication is impossible if the author of the document was simply filling in some text for all of the sections, and jammed in his class diagram. Of course documents written by templates aren't totally useless. Far from it. But they could be so much more useful if they where written in another way.

I realize that not using a strict template will put some more responsibility on the writer, but in my mind that is a good thing. They have to think about how they communicate. And if the writer is the same person that will be the lead of the implementation he already has that responsibility - to communicate well with his group. If they can't handle it, they need to learn how to write good documents, not how to fill in the blanks in a strict template.

But why can't people communicate just as well using strict templates?

Have you ever tried to use a template, but is wasn't exactly fit for your task? Say that most of the time you are writing technical specs for components of your system. So the template contains the obvious headings like Interface description, and Dependencies. Now, you want to write a technical spec for a windows service that you need in your project. It is sort of a component in the system, you think, and you have to follow the template anyway. But it turns out it doesn't really make sense. Under Interface description you write something like "The interface is the Windows Services Manager where you can start and stop the service". Ok, so what else is special about your Windows Service? Wouldn't it be better to just chuck the whole template that makes you write nonsense information under strange headlines, and just write a document that explains to your reader what the service is there for and how it's built?

Lets rather try and accomplish what the template was meant to do in the first place - help the writer to include all the relevant information, and keep the structure similar enough accross documents so that it's easy to find what you need in a document. The best way to do this is to have a separate document where you give some advice on how to write good documents. You can state things like that it's good to have an Abstract as the first chapter since this will let the reader quickly know what the document contains, and he can skip reading it if he was looking for something else. And that it's good to start by explaining what the problem is and how it is solved before you go into details of how it is to be implemented. Now the writers have something to refer to if they think they are forgetting something, and still they go through the thought process of writing that results in good documents.

posted on 5/24/2005 10:50:00 PM (W. Europe Standard Time, UTC+01:00)  #    Comments [0]

Related Posts:
Windows Forms UserControls in IE
Taming the Tab key's little brother
Combine() only two paths?
Refactorings
Debugger.Launch()
Microformats

Tracked by:
"nastiest whore in porn" (nastiest whore in porn) [Trackback]
"free videos female ejaculation" (free videos female ejaculation) [Trackback]
"jeremy paxman interview" (jeremy paxman interview) [Trackback]
"college dorm nudity" (college dorm nudity) [Trackback]
"welding hoods" (welding hoods) [Trackback]
"wild girl college party" (wild girl college party) [Trackback]
"disneyland ca" (disneyland ca) [Trackback]
"black gay porn" (black gay porn) [Trackback]
"female escorts in chattanooga" (female escorts in chattanooga) [Trackback]
"endodontic infections" (endodontic infections) [Trackback]
"doxycycline used for" (doxycycline used for) [Trackback]
"hot springs village hotel" (hot springs village hotel) [Trackback]
"us citizenship questions" (us citizenship questions) [Trackback]
"latina girls going wild" (latina girls going wild) [Trackback]
"sweepstakes may 2006" (sweepstakes may 2006) [Trackback]
"lets talk dirty" (lets talk dirty) [Trackback]
"joplin missouri" (joplin missouri) [Trackback]
"water stop rubber gloves" (water stop rubber gloves) [Trackback]
"naturist friends gallery" (naturist friends gallery) [Trackback]
"nude on the boat" (nude on the boat) [Trackback]
"traffic ticket texas" (traffic ticket texas) [Trackback]
"Angina Symptoms" (Angina Symptoms) [Trackback]
"no teletrack or verification payday loans" (no teletrack or verification payday... [Trackback]
"Houston act software training" (Houston act software training) [Trackback]
"italian amateur porn" (italian amateur porn) [Trackback]
"C2 Constellation" (C2 Constellation) [Trackback]
"mother fuck" (mother fuck) [Trackback]
"dirty bear sex gallery grizzly" (dirty bear sex gallery grizzly) [Trackback]
"tae kwon do winchester va" (tae kwon do winchester va) [Trackback]
"minor league baseball" (minor league baseball) [Trackback]
"myspace whore me button" (myspace whore me button) [Trackback]
"dirty lilly sucking" (dirty lilly sucking) [Trackback]
"hentai dating sim game" (hentai dating sim game) [Trackback]
"buy used car" (buy used car) [Trackback]
"candida albicans alcoholism" (candida albicans alcoholism) [Trackback]
"amateur girls kissing" (amateur girls kissing) [Trackback]
"dating gay" (dating gay) [Trackback]
"hummer H2 SUT" (hummer H2 SUT) [Trackback]
"final fantasy animated gifs" (final fantasy animated gifs) [Trackback]
"heavyweight vinyl envelopes" (heavyweight vinyl envelopes) [Trackback]
"farm animal cake sprinkles" (farm animal cake sprinkles) [Trackback]
"garmin 72 handheld gps" (garmin 72 handheld gps) [Trackback]
"evil deeds" (evil deeds) [Trackback]
"water brook publishers" (water brook publishers) [Trackback]
"cipro used for" (cipro used for) [Trackback]
"masturbating techniqus for women" (masturbating techniqus for women) [Trackback]
"fishing tackle catalogs" (fishing tackle catalogs) [Trackback]
"edm machining" (edm machining) [Trackback]
"fantasy cruse" (fantasy cruse) [Trackback]
"land forsale in diboll tx" (land forsale in diboll tx) [Trackback]
"sleep apnea symptom%27s" (sleep apnea symptom%27s) [Trackback]
"ambassador strip hotel in las vegas" (ambassador strip hotel in las vegas) [Trackback]
"incentivos mallorca" (incentivos mallorca) [Trackback]
"sex scenes from wild thing" (sex scenes from wild thing) [Trackback]
"restaurant hospitality" (restaurant hospitality) [Trackback]
"bruce hardwood flooring" (bruce hardwood flooring) [Trackback]
"porsche 928 for sale" (porsche 928 for sale) [Trackback]
"temperature controlled oven" (temperature controlled oven) [Trackback]
"ducted fan" (ducted fan) [Trackback]
"Louisiana Tech University" (Louisiana Tech University) [Trackback]
"what diseases caused by dirty water" (what diseases caused by dirty water) [Trackback]
"hp jornada 928 pocket pc" (hp jornada 928 pocket pc) [Trackback]
"home made weed killer" (home made weed killer) [Trackback]
"dilantin medicine and china" (dilantin medicine and china) [Trackback]
"young nude japanese school girls" (young nude japanese school girls) [Trackback]
"resort in sedona arizona" (resort in sedona arizona) [Trackback]
"tiger woods girlfriend" (tiger woods girlfriend) [Trackback]
"distance education master health" (distance education master health) [Trackback]
"erotic massage brooklyn" (erotic massage brooklyn) [Trackback]
"real dark black bitches thick asses" (real dark black bitches thick asses) [Trackback]
"breakers hotel" (breakers hotel) [Trackback]
"extreme pizza issaquah" (extreme pizza issaquah) [Trackback]
"horseback riding vacation in richmond virginia" (horseback riding vacation in r... [Trackback]
"gay shower" (gay shower) [Trackback]
"2033 paddock lane norco california" (2033 paddock lane norco california) [Trackback]
"porsche 928 body kits strosek" (porsche 928 body kits strosek) [Trackback]
"Pennsylvania funeral" (Pennsylvania funeral) [Trackback]
"film location scouts" (film location scouts) [Trackback]
"frame molding" (frame molding) [Trackback]
"discount laptops" (discount laptops) [Trackback]
"mini bike for sale" (mini bike for sale) [Trackback]
"university of washington medical center" (university of washington medical cent... [Trackback]
"mother of pearl necklace" (mother of pearl necklace) [Trackback]
"mc hawking bittorent" (mc hawking bittorent) [Trackback]
"God Bless the USA Lyrics" (God Bless the USA Lyrics) [Trackback]
"chain and sprocket guard sales" (chain and sprocket guard sales) [Trackback]
"Wrestling Nerve Holds" (Wrestling Nerve Holds) [Trackback]
"merger and acquisition" (merger and acquisition) [Trackback]
"troiemaiale" (troiemaiale) [Trackback]
"Furniture Malaysia" (Furniture Malaysia) [Trackback]
"Home business opportunities" (Home business opportunities) [Trackback]
"stepahie dog treats" (stepahie dog treats) [Trackback]
"kit helicopter" (kit helicopter) [Trackback]
"vinyl recording" (vinyl recording) [Trackback]
"casalingheincollantneri" (casalingheincollantneri) [Trackback]
"Sherwin Williams Paints" (Sherwin Williams Paints) [Trackback]
"microsoft office publisher" (microsoft office publisher) [Trackback]
"indian casino gaming history" (indian casino gaming history) [Trackback]
"Sat Online Registration" (Sat Online Registration) [Trackback]
"cheap airline ticket" (cheap airline ticket) [Trackback]
"Shampoo Bottle" (Shampoo Bottle) [Trackback]
"fungus vs chinch bugs" (fungus vs chinch bugs) [Trackback]
"devices hidden recording cameras" (devices hidden recording cameras) [Trackback]
"medical coding career" (medical coding career) [Trackback]