?

Log in

No account? Create an account

Previous Entry | Next Entry

What is it...

What is it with some programmers, who write really powerful tools like rsyslog, and then have the CRAPPIEST documentation. I mean, yeah, I get that the guy is German, so English is not his native language, but even accounting for german style grammar still had it too fragmented and incomplete.

It's like he took the documentation for each component out of the comments, threw a few words and headings around it, then threw them all on the floor. Then he picked up a few, and half-assed typed them into documentation pages, with hyperlinks based on thrice translated keywords, but in no particular order - just the order he picked them up in. He did this until he had picked up 80% of the pieces of paper, and slapped them on a few erratically indexed (and unsearchable) web pages, but missed a few that went under the couch. There is no consistency of terms, no clear definitions for some things, but perfectly fine lists for others, and no goddamn index!

Don't get me wrong, the software is brilliant, and configurable as hell, but the documentation just plain sucks big, fat, boulders through a 25ga needle.

Comments

( 2 comments — Leave a comment )
donsimpson
Feb. 5th, 2011 08:52 am (UTC)
Does that mean there is a market for proper documentation?
ravan
Feb. 5th, 2011 07:12 pm (UTC)
Oh, probably, but I have to figure the thing out before I can even start to write it. Sure, it's only a syslog replacement, one of several, but it lets you shove logs onto a server elsewhere in a usable format, which you need for large system clusters.
( 2 comments — Leave a comment )

Latest Month

October 2017
S M T W T F S
1234567
891011121314
15161718192021
22232425262728
293031    

Tags

Page Summary

Powered by LiveJournal.com
Designed by Lilia Ahner