Documentation: Definition and additional resources from ZDNet

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)

Reproduced with permission from Computer Desktop Encyclopedia.
Copyright (c) 1981-2008 The Computer Language Company Inc.
All rights reserved.

Additional Resources

12 terabytes of YouTube data: A lot of us block YouTube access in our schools. There's plenty of objectionable content worth hiding from young eyes. Probably an equal number of us, however, leave it open at the request of teachers who use its vast resources for teaching (yes, there is more than zit...; Tags: YouTube Inc., Video, Teacher, Viacom Inc., Chances, Corporate Communications, Marketing, Christopher Dawson; Blog posts 2008-07-03
Microsoft steps up self-policing of its OSI-approved source licenses: After pulling its "Sandcastle" documentation compiler from its CodePlex repository site for failure to comply with Open Source Initiative terms and conditions, Microsoft is ready to try releasing "Sandcastle" again under one of its OSI-approved licenses. by Mary Jo Foley; Tags: Team, OSI, Source Code, Microsoft Corp., Sandcastle, CodePlex, Team Management, Open Source, Management, Mary Jo Foley; Blog posts 2008-07-02
Anti-malware blocker, cross-site scripting protections coming in IE 8: Anti-malware blocker, cross-site scripting protections coming in IE 8Once again......late to the game. The "alternate" browsers have had these for a while. Competition breeds improvement, apparently. ;)It will still suckBeing a MS product, it will still suck.RE: Anti-malware blocker, cross-site scripting protections coming in IE 8Why would...; Tags: Web browsers, cross-site scripting protection, Anti-malware blocker, Anti-Malware, IE 8, blocker, XSS, Microsoft Internet Explorer; Discussion threads 2008-07-02
No crazies: 10 steps to kill IT failures: No crazies: 10 steps to kill IT failuresRe: exit stragegiesI think that, in regards to the first point of making it possible to pull the plug easily, that piece of advice should be given considerable thought before being acted upon. It is a sound, responsible thing to do to...; Tags: Backups, information technology, backup plan; Discussion threads 2008-07-02
MAX SIP ActiveX (exe): VoIP SDK to accelerate development of any type of VoIP-enabled application, like a SIP soft phone, teaching tool, live support, meeting tool or any other type of application which requires users being able to talk to each other. Deliver SIP-based communications and services for PC-to-Phone, Phone- to-PC and PC-to-PC services...; Tags: SIP, MAIN Telecom, Session Initiation Protocol (SIP), Emerging Technologies; Software downloads 2008-06-30

The heart of open source is trust: The heart of open source is trustGood topic but I think 'transparency' is the keyThe transparency of open source fosters truth. The truth builds the trust.Trust?It's about time people started ignoring the few headliners and realised some basic facts about open source.Trust?Yes you can trust that the new version will...; Tags: open source; Discussion threads 2008-06-27
Gov't failures: Engineering brain drain and bad leadership: Gov't failures: Engineering brain drain and bad leadershipIt's GovernmentWhy should anybody put any effort into any government project. There is no penalty for failure. The pay checks keep on rolling.The oversight Congress are a bunch of self serving fossils, who for the most part are clueless.However, the public...; Tags: Six Sigma, Government, brain drain, bad leadership, CMMI, leadership; Discussion threads 2008-06-27
(Fun with openSUSE 11.0): (Fun with openSUSE 11.0)But it's not Blue Like Windows ...Let's see who runs with that.I'm running OpenSuSE 11 on 2 machines and love both the KDE and GNOME desktop implementations. And, as an added surprise, all the server bits are there as well.If you've looked at Ubuntu or other...; Tags: Microsoft Windows Vista (Longhorn), Operating systems, OPEN SOURCE, Novell OpenSuse, openSUSE 11.0, Ubuntu, OpenSUSE 11, Linux, Microsoft Windows Vista, operating system; Discussion threads 2008-06-27
Time for open source to build a Code Recycling Center: Time for open source to build a Code Recycling CenterExcellent ideaExcellent idea. Often companies have utilities created for in-house use that are no longer needed. Years ago I wrote a utility to determine the answer date on lawsuits in Texas, which does not work on a "20 days...; Tags: Code Recycling Center, open source; Discussion threads 2008-06-26
Sorry Simon, but you're still screwing up: Sorry Simon, but you're still screwing upSorry Dana, but you scewed upHi Dana,I totally agree that more transparency would be a good thing for Sun and its products and projects, and more openness would be the next big step. Beyond that I don't agree with much that you wrote here.>...; Tags: Team management, Databases, Sun Microsystems Inc., open source, Simon, non-development community, open source project, team, MySQL; Discussion threads 2008-06-24
Mobile RIAs - getting more exciting thanks to Nokia and Symbian: Big news today for those following mobile RIAs closely. Nokia is buying the remaining 52% of Symbian that it doesn't own and making the mobile platform open source. As Steve O'Hear said, the move is "bold to say the least". At a time when everyone is trying to make a...; Tags: Nokia Corp., Mobile, Open Source, Rich Internet Application, Symbian Inc., Advertising & Promotion, Marketing, Ryan Stewart; Blog posts 2008-06-24
Developers criticize Nvidia, other holdouts for hindering Linux desktop: Developers criticize Nvidia, other holdouts for hindering Linux desktopInteresting[i]We have repeatedly found them to be detrimental to Linux users, businesses and the greater Linux ecosystem,” the letter stated. “Such modules negate the openness, stability, flexibility and maintainability of the Linux development model and shut their users off from the expertise...; Tags: UNIX, OPEN SOURCE, Operating systems, Desktops, Linux desktop, Nvida, desktop, EXT, NVidia Corp., Linux, ATI Technologies Inc.; Discussion threads 2008-06-23
Old DEC code open sourced by HP: AdvFS offers solid security and back-up features, along with fine-grain control of file systems and free space, according to the SourceForge page. The documentation for AdvFS is living on the H-P site. by Dana Blankenhorn; Tags: Hewlett-Packard Co., Digital Equipment Corp., Wiki, Linux, Productivity, Online Communications, Operating Systems, Software, Dana Blankenhorn; Blog posts 2008-06-23
A-Z Contacts Manager (exe): Whether you are small business, corporation or individual person, you will find A-Z Contacts Manager very useful in managing all kinds of contacts information, mark many events dates you wanted to be automatically reminded of, send bulk email message with file attachments to all or selected groups of your contacts....; Tags: Password Protection, Manager, JosyTal, Storage, Databases, Hardware, Enterprise Software, Software, Data Management; Software downloads 2008-06-23
Fresh off the press: iPhoneDbg toolkit hotness: The guys at Core Security just released an iPhoneDbg toolkitÂ that should make exploit development for the iPhone much easier.Â This is outstanding news for all, as I think there has been a lot of concern over the quick rise of mobile devices and the new security concerns that they create.Â ...; Tags: Apple iPhone, iPhone Debugger, Nathan McFeters; Blog posts 2008-06-18
Government 2.0: Focus is on IT recruiting: Government 2.0: Focus is on IT recruiting2.0 crazeMost companies and government institutions that I deal with have a well established CMS that allows the correct employees to inform the public and the organization about what is going on. Most do include appropriate content such as maps and documentation that...; Tags: Content management, content management system, Government 2.0, IT recruiting, information technology; Discussion threads 2008-06-17
Literate programming: Literate programming*blink*Full time programers don't do this? I learned FORTRAN around 1980 and the text required "a structured and disciplined style." That may not be the same thing as "literate programming" but it seems close. I know I have a hard time getting statisticians to document their project specific analysis...; Tags: Development tools, programming, programmer; Discussion threads 2008-06-17
Continuous prototyping: Continuous prototypingFavourite "agile" tricksOne of the ideas in web development that holds true in this context is to get the user "building" as much as possible. A lot of the back and forth stuff disappears when the user is psychologically involved in the process - ie, if they actually chose...; Tags: Manufacturing, Continuous Prototyping, Demming, software development; Discussion threads 2008-06-16
Open letter to a school committee member: A bit of background before I pass on this letter that I wrote to a member of our school committee this morning...Our district has been without a technology-director type for many years now. While we have good staff handling individual schools, coordinating and managing the use of technology district-wide...; Tags: District, Technology, Tools & Techniques, Productivity, Management, Christopher Dawson; Blog posts 2008-06-12
Wiki2EXE (exe): Wiki2EXE compiles wiki-like source code into stand alone programs. Several styles of linking are supported like: inline links, hyper links, email links, program links and document links. The syntax used is easy to understand too, and you'll be up and running with only a few mouse clicks. The resulting executables...; Tags: Zeno Systems, Wiki2EXE, E-mail, Wiki, Mice, Training And Certification, Online Communications, Hardware, Peripherals; Software downloads 2008-06-12