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:System documents for developers From:"Allyson C. Harris" <aharris -at- ROCKTENN -dot- COM> Date:Mon, 16 Feb 1998 17:45:27 -0500
Suzy Davis posted an excellent document last week on the content of
functional specification documents, for both end users and developers.
I've been assigned the task of writing system documentation on an existing
manufacturing system for our IS staff and I'm wondering what types of
content others have seen or included in system documentation for
developers? Do you flow charts? How detailed is the textual content?
Any and all advice would be greatly appreciated! My audience has been the
end user so this is new territory for me...
