How not to write your documentation (1)
I'm developing some software to run under a 3rd party infrastructure.
This infrastructure supports components written in a variety of languages. Java, .Net, C++, blah, blah.
Unfortunately, when the company who decided how they were going to write their documentation, they decided that they would try and produce 1 document, covering how to do each bit in each language.
They've ended up with a mess. .Net implementations next to java implementations next to... for each and every bit, or well, for each and every bit where they've felt like providing an example in your language. Well, if you can do that bit in your language, of course.
It would have made everybody's life easier if they'd produced separate documents for your language. E.g. a .Net developers guide, a Java developer's guide, and so on.
Grrrrrrrrr.
This infrastructure supports components written in a variety of languages. Java, .Net, C++, blah, blah.
Unfortunately, when the company who decided how they were going to write their documentation, they decided that they would try and produce 1 document, covering how to do each bit in each language.
They've ended up with a mess. .Net implementations next to java implementations next to... for each and every bit, or well, for each and every bit where they've felt like providing an example in your language. Well, if you can do that bit in your language, of course.
It would have made everybody's life easier if they'd produced separate documents for your language. E.g. a .Net developers guide, a Java developer's guide, and so on.
Grrrrrrrrr.
posted by dan at
10:55 am
3 Comments:
This comment has been removed by a blog administrator.
By
Anonymous, at 11:06 am
yay, spam comments ;)
serves you right for using an out of the box blog ;) ;) ;)
By
Anonymous, at 4:55 pm
I'm actually pretty close to finishing off my own site... whether it sees the light of day or not is another matter though :-)
I like Blogger, but I hate spammers who take advantage of what is more a belief (i.e. open commenting) than a flaw.
B'stards.
By
dan, at 9:25 am
Post a Comment
<< Home