TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Internal Systems Docs From:Jan Jackson <jjackson -at- SUSQ -dot- COM> Date:Fri, 3 May 1996 17:14:54 EDT
I would appreciate any advice or resources on documenting
the internals of a large, complex UNIX software system.
The intention is to provide new & existing programmers with
a technical overview of the pieces of the system and how they
fit together and code-level detail on the major procedures,
libraries, etc. to reduce the significant learning curve.
We envision an online system in which you click on a piece to
reveal further detail, and will probably do it in html.
I'm wondering how such systems are documented elsewhere. I've
done much smaller systems from programmers' notes and
code, but am not sure where to begin on such a big project.
I'm also particularly interested in learning of any ways to
automate the process, such as using tools to extract comments or
other information from code.
Any comments would be appreciated, either to the list or to my
Jan Jackson, Technical Writer
Susquehanna Investment Group
email: jjackson -at- susq -dot- com fax: (215)963-7340 (USA)
Post Message: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Get Commands: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "help" in body.
Unsubscribe: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "signoff TECHWR-L"
Listowner: ejray -at- ionet -dot- net