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:Oracle and System Docs From:Jerolynn Cochrane Thomas <cochrane -at- CARIBSURF -dot- COM> Date:Thu, 2 Oct 1997 16:07:44 -0400
Due to events beyond my control, I'm now in the position of having to
write system documentation for a handful of small Oracle applications.
I have no experience with Oracle, but have done some programming in my
past (3G/L's only). I have two questions:
1. Can I have some input on exactly what system documentation
constitutes, especially with respect to Oracle. The developer defines it
as "more than pseudo-code; a detailed description of modules such that a
programmer could find his/her way around using the documentation."
2. Where do I start with Oracle. These developers are using
Developer/2000 Reports and Forms, SQL, etc. Oracle has tens of manuals
online, but I can't seem to find a starting point.
Did I mention that the actual developers are on vacation?