I'm making the manual for two little softwares we have here at work. One is a (very simple) Delphi program that receive a plain-text file as input, process it and return flow and volume graphics. The second one is a LabVIEW (a National Instruments system for acquisiting lab. data) interface which is responsable for receiving the sign sent by our instruments and returning the plain-text file used in the Delphi program.
The LabVIEW program is kinda easy to document. First, because nobody here knows how to use it (and nobody wants to learn it too). Second, because it has a graphic interface, so I'll just take some screenshots showing the steps to do it and third, because I did this one.
The Delphi thing is more complicated. Is the first time I'm hacking Delphi, and from previous experiences with Pascal, I know I won't like it. Second because, before me, two other interns hacked up with it, so it is just one big mess.
I already wrote a HOWTO kind of document to help the labtechs use it. Is more like a step-by-step guide to the whole system, since they are not interested in detais on how it work, but only how to make it work. I know that because they told me.
The software documentation is something I struggled with my boss for a while. It's not like we make a lot of softwares ourselves (or use a lot of diferent ones), but we have like two or three of our own, and every time we have to update it is a great drama. For example, I'll be leaving IPT at the end of the year, so if I refuse to document the LabVIEW things I did, the next intern would have to figure it out by himself. I don't want to spoil the next one, but to avoid losing a week or two on updates.
I guess I should be happy them, since I'm doing something I was asking for.
