Want to read Slashdot from your mobile device? Point it at m.slashdot.org and keep reading!

 



Forgot your password?
typodupeerror
×
Programming

Journal alien_blueprint's Journal: Writing documentation is hard work

So, I've been trying to complete the POA stuff in the Fnorb documentation this afternoon - it's really slow going when you haven't touched it for months. I can't remember what half these POA policy values are for, let alone what they mean or how much of it I actually implemented. So I've got a window with the POA spec in it, a window with the documentation I'm editing open, and about 20 other windows viewing different parts of my POA code as I try to put it all together in my head again.

But I've completed the policies and configuration bit and now I'm moving on to the "using the POA" part which will hopefully be less tedious. This is why OSS stuff sometimes has less than complete documentation - it's just no fun at all if you don't do it right away, and on a part-time project that's not always feasible.

Update 9:17pm: POA section finished. It probably needs revising and rearranging a little, and certainly the references aren't right, but the basic content is done.

This discussion has been archived. No new comments can be posted.

Writing documentation is hard work

Comments Filter:

I've noticed several design suggestions in your code.

Working...