Question: Documentation of software programs and systems

Thu 2 Sep 2010 - 5:18 pm UTC

| |

EXPIRED

Question: Documentation of software programs and systems

Home » Science and Mathematics » #1907

Please carefully read the Disclaimer and Terms & conditions.
Priced at $15.00

Actions: Add Comment

Asked by david r on Wed 21 May 2008 - 1:21 pm UTC:

Hi,
I'm proposing a service to a financial entity's IT department regarding
documenting their systems, especially programs and production steps. This
is for program maintenance matter. The programs are old' written in various
programming languages. I'll also prepare documentation instructions for
their existing programmers and system analysts.
My questions therefore are:
1. Systems/programming documentation methodologies, instructions?
2. What is the ratio of technical writers - programmers?
3. Tools for the above.
Thanks.

Uclue Researcher Comment by Researcher mathtalk on Mon 26 May 2008 - 4:14 am UTC:

Hi, david r:

Providing maintenance documentation for an eclectic, heterogenous
collection of legacy software is a daunting task, which no doubt explains
the request for your proposal.

If you don't already have it in your personal library, I recommend the book
Peopleware (Dorset House, 1987) by Tom DeMarco and Timothy Lister:

[Peopleware: Productive Projects and Teams]
http://www.amazon.com/Peopleware-Tom-Lister-Timothy-Demarco/dp/0932633056

There are companies that provide a kind of productized "Methodology" for
program development, with training classes and lots of three-ring binder
manuals, etc., but this doesn't sound like a good fit for your client.

Instead it sounds like you can best help them by understanding the existing
"traditions" of software development and helping them to maintain essential
documentation in a more robust way by selective, incremental introduction
of tools for version control, regression testing, production moves, and
interface specifications.

I'm not sure how much/what kind of an answer you are looking for at the
price offered, but these are my thoughts after mulling over your question
for a couple of days.

regards, mathtalk

Actions: Add Comment

Bookmark it!