Writing header docs
Writing header docs
- Subject: Writing header docs
- From: Tim Hart <email@hidden>
- Date: Wed, 26 May 2004 14:27:18 -0500
Documentation. The evil, horrible thing that developers at one time in
their lives must write. *shudder*
I've been lucky enough to avoid most documentation assignments in my
professional life. Now I'm faced with making sure that there is good
documentation for my open source library.
I'm good to go with HeaderDoc, etc. All the technical details are
ironed out. Now it's just a matter of making sure that others don't
complain about my documentation as much as I complain about others (ah,
the irony of being on the other side of the fence).
Does anyone have pointers, links, anecdotes, or sage advice for writing
clean, consumable technical documentation? I've already thought about
pawning it off on someone else... that's not likely to happen...
Tim
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.