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.
I am hoping for some opinions on what constitutes good system documentation
for a Windows application. That is, this very technical documentation is
intended to support the maintenance and enhancement of the application by
programmers (say Visual Basic).
Should the writer assume that all users of the document are expert VB
programmers who are familiar with every slick coding routine that your
programmer could possibly have included in the application? (In otherwords,
how do you decide which sections of code really cry out for explanation?)
How much info should accompany an API call? Is a hard copy manual even
advisable -- should the documentation be on-line with links to the VB Help?
Does anyone know of a software tool / add-in that extracts the procedures /
arguments from the Visual Basic code (thus punching out a skeleton for the
systems document)? Or is it better to show simply and graphically how the
application supports the business requirements: major inputs, macro
processes, databases (thus largely ignoring the details)? (But then, are
these graphic representations more to help reassure the business owners /
managers that the programmer has done what they were paying for?)
Many Thanks for your comments and opinions.
Bruce McCowan, P.Eng.
Great Dane Consultants
bmccowan -at- gr8dane -dot- com