Program/Project Documentation
-
I have spent the best part of the last 2 years as a consultant (networks, installing OS/products getting everything communicating, supporting morons) doing very little coding at work and a young family at home meant no coding after hours. I have decided to build a couple of small useless apps to get up to speed again and thought for once I would go the whole hog and document and backup source and all that stuff you should do anyhow. A hard drive crash a year ago blew away all of my backed up data (no tapes) including program specification documents I had used in the past when I was developing code for work and pleasure. Searching the net and asking old colleagues has given me nothing. Wondering if anyone out there may have some templates, ideas or URL's lying around they wouldn't mind sharing with me? Does anyone else document their personal projects or do they just rely on comments and memory to determine how they did stuff in the past? From Aussie where Michael is shortened to Mick and not Mike and we all sit on our arse not ass. :-D Michael Martin Pegasystems Pty Ltd Australia martm@pegasystems.com +61 413-004-018
-
I have spent the best part of the last 2 years as a consultant (networks, installing OS/products getting everything communicating, supporting morons) doing very little coding at work and a young family at home meant no coding after hours. I have decided to build a couple of small useless apps to get up to speed again and thought for once I would go the whole hog and document and backup source and all that stuff you should do anyhow. A hard drive crash a year ago blew away all of my backed up data (no tapes) including program specification documents I had used in the past when I was developing code for work and pleasure. Searching the net and asking old colleagues has given me nothing. Wondering if anyone out there may have some templates, ideas or URL's lying around they wouldn't mind sharing with me? Does anyone else document their personal projects or do they just rely on comments and memory to determine how they did stuff in the past? From Aussie where Michael is shortened to Mick and not Mike and we all sit on our arse not ass. :-D Michael Martin Pegasystems Pty Ltd Australia martm@pegasystems.com +61 413-004-018
I have written a few shareware/freeware applications in the past 8 years. I never created a spec for any of these because they were all too small. I think most of these programs were 10,000 lines long (or less), so I just used comments to document functions and functionality. I don't think a fully documented spec is really necessary unless the project is over 20,000 lines of code. Brigham W. Thorp Software Engineer Timex Corporation