FOSS and documentation

2007-07-18T15:23:42Z
Dave Pawson.  link
Home

FOSS and documentation

FOSS and documentation

This piece tried to find out why people write documentation (specifically, rather than FOSS software). I contributed to it, and can't in all honesty argue, since it's not something I've seriously considered. I've been writing documentation of one sort or another for some time now. Why? I doubt I could give a truthful answer, but I like to help where I can and not being a natural programmer, I find second order tasks just as useful. I do know that when I've approached a new piece of software, it's generally the quality of the documentation that forms my first judgement. Good documentation makes even klunky software usable. The same guy is now looking at what works on a mailing list. this is his article. I found it intriguing. The XSLT list is my reference, due in no small part to a few household names, backed by a drift of other people who just enjoy being helpful, or have their own motives for joining in a thread. Often (IMHO) it's just a simple case of joint learning? By helping the OP they are also educating themselves, clarifying some aspect of the subject and building up a deeper level of understanding. Since it's on a public list, the public benefit from those conversations. The only harsh words seem to be a reminder as to what's on topic and what's not and the hint that good clear questions get answered more often than hurried or vague ones.

Some time back I joined another list which I found to have the same few regulars, seemingly knowledgable (I had no benchmark for their knowledge) on the subject, but with quite a different attitude. If the newby didn't understand it the first time, repeat it with no rider, expansion or whatever. Basically total lack of empathy with the person asking. Eventually I grew sick of it and unsubbed. I'd no desire to listen to such crap when I know how well it can work.

A further experience this last week or so. A group I know (insofar as email lets you know someone) proved to have something of a quirk which I found revealing. I offered to help out with documentation and found what I considered to be weaknesses in the markup and processing. When I pointed these out the response seemed to indicate that they'd all been through that learning curve, so why shouldn't I, and any others that offered. Either learn it by wasting time, asking questions from the current group and generally being made to feel a pratt, or don't bother. Basically don't rock the boat. I came away feeling that the group didn't welcome effort, were content with the arcanary they'd all learned etc. I may be mistaken, but we'll see. Luckily it was only about 60 hours work.

It has me wondering on the psychology of group interaction via the keyboard. We each sit here adding and taking away from the net, basically alone with our thoughts, yet the interactions are just as strong as the meeting room interactions which are face to face.

Keywords: docbook

Comments (View)

Return to main index