The narrative and graphical description of a system. Following are the kinds of documentation required to describe an information system for both users and systems staff. See self-documenting code, technical writer and RTFM.
Operating Procedures
1. Instructions for turning the system on and getting the programs initiated (loaded).
2. Instructions for obtaining source documents for data entry.
3. Instructions for entering data at the terminal, which includes a picture of each screen layout the user will encounter.
4. A description of error messages that can occur and the alternative methods for handling them.
5. A description of the defaults taken in the programs and the instructions for changing them.
6. Instructions for distributing the computer's output, which includes sample pages for each type of report.
System Documentation
1. Data dictionary - Description of the files and databases.
2. System flow chart - Description of the data as it flows from source document to report.
3. Application program documentation - Description of the inputs, processing and outputs for each data entry, query, update and report program in the system.
Technical Documentation
1. File structures and access methods
2. Program flow charts
3. Program source code listings
4. Machine procedures (JCL)
Operating Procedures
1. Instructions for turning the system on and getting the programs initiated (loaded).
2. Instructions for obtaining source documents for data entry.
3. Instructions for entering data at the terminal, which includes a picture of each screen layout the user will encounter.
4. A description of error messages that can occur and the alternative methods for handling them.
5. A description of the defaults taken in the programs and the instructions for changing them.
6. Instructions for distributing the computer's output, which includes sample pages for each type of report.
System Documentation
1. Data dictionary - Description of the files and databases.
2. System flow chart - Description of the data as it flows from source document to report.
3. Application program documentation - Description of the inputs, processing and outputs for each data entry, query, update and report program in the system.
Technical Documentation
1. File structures and access methods
2. Program flow charts
3. Program source code listings
4. Machine procedures (JCL)
 | Reproduced with permission from Computer Desktop Encyclopedia. Copyright (c) 1981-2009 The Computer Language Company Inc. All rights reserved. |
Additional Resources
- TechWriter for Databases 2009 (Windows)
- One of the Adivo Successful Documentation Generators, TechWriter for Databases is a Windows application that generates documentation for database tables, views, functions and procedures. It supports Access, SQL Server and Oracle. TechWriter automatically generates the documentation for your database. By collecting information about the tables, views and procedures directly from...
- Software downloads 2009-11-20
- TechWriter for XML Schemas 2009 (Windows)
- Complete and Accurate XML Documentation of your XML Schema is finally achievable. Adivo's TechWriter for XML Schemas is a documentation generator for XML Schema Definitions XSDs and XML DTDs. TechWriter for XML Schemas leverages the information locked inside your XML schemas to provide quality documentation. By collecting information about the...
- Software downloads 2009-11-20
- TechWriter for Web Services 2009 (Windows)
- Complete and Accurate Documentation of your Web Services is finally achievable. TechWriter for Web Services is a Windows desktop application that generates documentation for web services. TechWriter automatically generates the documentation for your web service. By collecting information about the methods, elements, attributes and types directly from the WSDL that...
- Software downloads 2009-11-20
- Apple Server Admin Tools 10.6.2 (Mac)
- This download contains remote administration tools, documentation, and utilities that you can install on a computer other than your server.
- Software downloads 2009-11-19
- HeathSoft Doc 8.44 (Windows)
- HealthSoft Doc is a documentation and patient management program designed by a chiropractor with the intent of developing the ultimate documentation program for chiropractors and physical therapists. As well as being comprehensive it s also very easy to learn and use. A few of the long list of features include:...
- Software downloads 2009-11-18
- Bugzilla 3.4.4 (Mac)
- Bugzilla is the leading open-source/free software bug tracking system, with high-profile installations at mozilla.org (250,000 entries), Gnome, Red Hat and NASA, among others. It features a comprehensive set of fields, attachment management, inter-bug dependencies, email notification of changes, a powerful query interface, reporting, and web, xml, email and console interfaces....
- Software downloads 2009-11-18
- MySQL Workbench OSS 5.2.8b1 (Mac)
- MySQL Workbench enables a DBA, developer, or data architect to visually design, generate, and manage all types of databases including Web, OLTP, and data warehouse databases. It includes everything a data modeler needs for creating complex ER models, and also delivers key features for performing difficult change management and documentation...
- Software downloads 2009-11-18
- dataComet-Secure 10.2.0 (Mac)
- dataComet-Secure for OS X offers fast, reliable terminal emulation for local Shell sessions, SSL / TLS Telnet / TN3270, SSH1 & SSH2, and serial devices such as modems Telnet sessions offer Kerberos 5 and SOCKS v4 security options Supports both SSH1 and SSH2 sessions with strong encryption + SCP...
- Software downloads 2009-11-17
- dataComet 10.2.0 (Mac)
- dataComet for Macintosh OS X offers fast, reliable terminal emulation for local Shell sessions, Telnet, and serial devices such as modems Emulates VT100, VT220, VT320, PC-ANSI, SCO-ANSI, and IBM-3278 and IBM-3279 for mainframe access Extensive file transfer support: X/Y/ZModem, IBM IND$FILE Edit windows for off-line composition with easy paste-thru...
- Software downloads 2009-11-17
- NMath Stats 3.1 (Windows)
- NMath Stats contains a data table class with functions for computing descriptive statistics, such as mean, variance, standard deviation, percentile, median, quartiles, geometric mean, harmonic mean, RMS, kurtosis, skewness, and many more; PDF, CDF, inverse CDF, and random variable moments for a variety of probability distributions, including normal Gaussian, Poisson,...
- Software downloads 2009-11-17
- Altova XMLSpy Enterprise Edition 2010 (Windows)
- Altova XMLSpy 2010 Enterprise Edition is the industry's best-selling XML editor and XML development environment for modeling, editing, transforming, and debugging XML technologies. In addition to the world's leading XML editor, XMLSpy includes a powerful graphical XML Schema editor that allows you to design complex schemas with ease. Advanced error...
- Software downloads 2009-11-16
- ProfCast 2.6.4 (Mac)
- ProfCast is a versatile, powerful, yet very simple to use tool for recording lectures and creating enhanced podcasts. ProfCast provides a low cost solution for recording and distributing lectures, special events, and presentations as podcasts. ProfCast offers an integrated workflow that makes creating, recording, and publishing podcasts easy. It's as...
- Software downloads 2009-11-16
- Five JavaScript Frameworks: A Point-by-Point Comparison
- There are a multitude of JavaScript frameworks available today for programming rich client-side interactions in web applications. With many such different options, it is important to choose a framework that not only serves the current requirement, but also serves one in the long run. This paper draws up a visual...
- White papers 2009-11-16
- Groklaw suggests Microsoft sue, do over authentication
- Are you in any way trying to legitimize patent trolling?You are well aware that what Microsoft is doing is what we all used to call patent trolling aren't you?My guess...Nothing will happen... this is just MS trying to protect UAC and runas from paten lawsuits.Besides MS would be idiot... well...
- Discussion threads 2009-11-13
- Five Cellular Automata 7.60 (Windows)
- This is software for exploring five cellular automata, as follows: A multistate version of Conway's Game of Life, called "q-state Life"; A simulation of the Belousov-Zhabotinsky chemical reaction in which, beginning from a random state of the system, spirals and curlicues "spontaneously" emerge; A process called Togetherness in which cells...
- Software downloads 2009-11-11
- MadCap Flare 5.0.1 (Windows)
- Flare is the industry benchmark in multi-channel, single-source publishing. Flare helps documentation professionals, technical writers, and Help authors harness the power and benefits of XML without any XML language programming knowledge. Our unique visual editor allows users to write content just like you would in Microsoft Word.
- Software downloads 2009-11-10
- Why I'm letting someone else run my Exchange 2010 server
- Why ironic?Given that exchange is the de facto standard in business email/cal having their products working as perfectly as possible with exchange is a must. Not only that, they advertise this functionality. Did you expect it to fail miserably? Your expectations must have been low. Heh.It took yearsNative Exchange support...
- Discussion threads 2009-11-09
- Type And Creator Changer 6.0 (Mac)
- You want to convert the type and creator of any file? You want to give you own type and creator or to give the same ones as other files? You want to perform the type and creator conversion on several files at once? You want to associate file with the...
- Software downloads 2009-11-09
- Plain Text Editor 5.0 (Mac)
- You miss a text editor able to open, edit and save plain text files? You want special features such as foreground and background colors? Text wrapping and unwrapping? Macintosh, Windows and Unix ends of lines? Spelling checking? Find and replace? Regular expressions? Unlimited number of undo? Then Plain Text Editor...
- Software downloads 2009-11-09
- Startup Chime Stopper 4.0 (Mac)
- You are fed up with the irritating chime of your Macintosh at startup? You want to remove it? You want to start your Macintosh without noise? Then Startup Chime Stopper is what you need! Startup Chime Stopper allows you to remove the irritating chime of your Macintosh at startup....
- Software downloads 2009-11-09
Neighboring Terms
Premier Vendor Content Whitepapers, webcasts & resources from our Power Center Sponsors
- Learn more about tools to grow your business
-
The Business Essentials Guide provides you useful tools and templates to help grow your business and save you time with automated shipping solutions.
- Save time with the UPS Business Essentials Guide
- Reduce risk. Reduce complexity. Increase reliability.
-
A simplified IT environment isn't just less complex. It's also more reliable. Standardize on a single Linux platform with SUSE Linux Enterprise from Novell, and get the world's most interoperable Linux
- Learn more >>
- Microsoft Dynamics CRM Online - Free Six-Month Trial for Eligible Organizations
-
Microsoft Dynamics CRM Online provides fast online access, simple contact management and better sales performance for a low monthly cost - the best value on the market today.
- Learn more about the free, six-month trial offer>>
- The best support in the Linux business
-
If Linux is going to power your mission-critical applications, you'd better have the best support known to business. Novell was rated the top provider of Linux technical support.
- Learn more >>
Meet Doc
-
-
Here to help you with your Document Management Needs
- Doc is an enigma. Born to a Russian ballerina and a German electrical engineer, he grew up in various locations in the United States. He’s seen the insides of more brands, versions, and generations of printer and printer-related hardware than almost anyone.
- To learn more about this mysterious figure check out his blog on ZDNet and his Workspace on TechRepublic. You’ll be glad you did.
-
Produced by
ZDNet and -
