! Aware > default selections > Activity specific > Software Development > Documentation >

Software Documentation

- - Creating user and developer documentation. Visualizing existing systems.
Subsets on this page: - #Apps & Utilities - #Q&A - #Articles - #Books -
- #Personalize -
Search ! Aware:

  By ANN

Search all pages


By activity
Professions, Sciences, Humanities, Business, ...

User Interface
Text-based, GUI, Audio, Video, Keyboards, Mouse, Images,...

Text Strings
Conversions, tests, processing, manipulation,...

Integer, Floating point, Matrix, Statistics, Boolean, ...

Algorithms, Memory, Process control, Debugging, ...

Stored Data
Data storage, Integrity, Encryption, Compression, ...

Networks, protocols, Interprocess, Remote, Client Server, ...

Hard World
Timing, Calendar and Clock, Audio, Video, Printer, Controls...

File System
Management, Filtering, File & Directory access, Viewers, ...

Books: Showing

Documenting Software Architectures: Views and Beyond
[Paul Clements (Editor), et al; 2002-07-05] ISBN 0201703726
- At Barnes & Noble - At Amazon - At Half

RoboHELP 2000 Bible (with CD-ROM)
[John V. Hedtke, et al; 2000-01-15] ISBN 0764546449
- At Barnes & Noble - At Amazon - At Half

DocBook: The Definitive Guide (O'Reilly XML)
[Norman Walsh, Leonard Muellner; 1999-10] ISBN 1565925807
- At Barnes & Noble - At Amazon - At Half

RoboHELP® 7 For Dummies®
[James G. Meade, Jim Meade; 1999-08-11] ISBN 0764505602
- At Barnes & Noble - At Amazon - At Half

BUGS in Writing: A Guide to Debugging Your Prose (2nd Edition)
[lyn dupre; 1998-01-15] ISBN 020137921X
- At Barnes & Noble - At Amazon - At Half

Managing Your Documentation Projects
[Joann T. Hackos; 1994-03-23] ISBN 0471590991
- At Barnes & Noble - At Amazon - At Half

Articles: Showing

Visualizing and Analyzing Software Infrastructures ( Adam Buchsbaum, Yih-Farn Chen, Huale Huang, Eleftherios Koutsofios, John Mocenigo, Anne Rogers, Michael Jankowsky, Spiros Mancoridis ; IEEE Software Magazine 2001-09)

- Operations in today's large corporations are usually supported by complex software infrastructures that involve hundreds or thousands of software systems. Companies frequently need to redesign their software infrastructures in response to marketplace changes in the. This article describes the Enterprise Navigator, a system that lets architects visualize system interconnections of selected products and services by making database queries on the Web. Moreover, analysis tools are provided for the architects to examine dominating information flows, perform clustering analysis to find substructures, and study the structural evolution of particular business processes or functions. The system has been used extensively on AT&T's System Profile Database. The article also includes a case study to show how an architect can use Enterprise Navigator to perform various visualization and analysis tasks.

Reverse-Engineering New Systems for Smooth Implementation ( Peter Aiken, Ojelanki K. Ngwenyama, Lewis Broome ; IEEE Software Magazine 1999-03)

- Reverse-engineering a commercial client-server system from PeopleSoft yielded a valuable resource and proved to be cost-effective. The authors describe the motivations for, approach to, and results of this project, commissioned by the Commonwealth of Virginia's government.

Defining a Discipline of Description ( Michael Jackson ; IEEE Software Magazine 1998-09)

A Standard for Software Documentation ( Vir Phoha ; IEEE Computer Magazine 1997-010)

Recovering Design and Specifications from Source Code ( Noah Prywes ; IEEE Software Magazine 1996-11)

- Taking the guesswork out of tool selection.

Software Visualization in the Large ( Thomas Ball, Stephen G. Eick ; IEEE Computer Magazine 1996-04)

- The invisible nature of software hides system complexity, particularly for large team-oriented projects. The authors have evolved four innovative visual representations of code to help solve this problem.

Backfiring: Converting lines-of-code to function points ( Capers Jones ; IEEE Computer Magazine 1995-11)

Help-system development tools ( Bill Bell ; IEEE Computer Magazine 1995-05)

Structural Redocumentation: A Case Study ( Kenny Wong, Scott R. Tilley, Hausi A. Müller, Margaret-Anne D. Storey ; IEEE Software Magazine 1995-01)

- Most software documentation typically describes the program at the algorithm and data-structure level. For large legacy systems, understanding the system’s architecture is more important. The authors propose a method of reverse engineering through redocumentation that promises to extend the useful life of large systems. Programmers have become part historian, part detective, and part clairvoyant. — Thomas A. Corbi

Planning the Reengineering of Legacy Systems ( Harry M. Sneed ; IEEE Software Magazine 1995-01)

- How can you know if reengineering is cost-effective? If it is preferable to new development? Or to maintaining the status quo? The author proposes a way to quantify the costs and prove the benefits of reengineering over other alternatives and offers some advice on contracting a reengineering project.

A Taxonomy of Program Visualization Systems ( Gruia-Catalin Roman, Kenneth C. Cox ; IEEE Computer Magazine 1993-12)

- A taxonomy of program visualization systems that is based on a model of program visualization that maps programs to graphical representations is presented. The taxonomy is illustrated with three program visualization systems representative of research trends: Zeus, Tango, and Pavane.

Design Recovery for Maintenance and Reuse ( Ted J. Biggerstaff ; IEEE Computer Magazine 1989-07)

- Software maintenance and harvesting reusable components from software both require that an analyst reconstruct the software's design. Design recovery recreates design abstractions from a combination of code, existing design documentation (if available), personal experience and general knowledge about problem and application domains. The author shows how to extend the automated assistance available to the software engineer for this process. He explains the concept of design recovery, proposes an architecture to implement the concept, illustrates how the architecture operates, describes progress toward implementing it, and compares this work with other similar work such as reverse engineering and program understanding. Much of the discussion is based on a model-based design recovery system called Desire.

Exploring Algorithms Using Balsa-II ( Marc H. Brown ; IEEE Computer Magazine 1988-05)

- The use of the Balsa-II algorithm animation environment to investigate the dynamic behavior of programs is discussed. Balsa-II is examined first from a user's perspective and then from a programmer's perspective. Some related systems are briefly considered.

Questions and Answers: Showing

Beginning Project Documentation? [2002/03/20]

At Ask Slashdot

Visualising Code Structure in Large Projects? [2002/02/15]

At Ask Slashdot

Resources on the Theory Behind Decompilers? [2001/05/09]

At Ask Slashdot

Software Documentation Standards? [2001/05/02]

At Ask Slashdot

Commenting and Documentation in Free Code? [ 2000/08/28]

At Ask Slashdot

Reverse Engineering? [ 1999/09/29]

At Ask Slashdot

Applications and Utilities: Showing

ID Utils - is a package of simple, fast, high-capacity, language-independent tools that index program identifiers, literal numbers, or words of human-readable text. {GPL,GNU}

At GNU project

y2l-1.1 - Yacc-to-Latex pretty printer/convertor

At FreeBSD Ports

vcg-1.30 - A Visualization Tool for compiler graphs

At FreeBSD Ports
Visualization Tool for compiler graphs (At NetBSD packages collection)

c_c++_reference-1.08 - C/C++ reference manual for KDevelop

At FreeBSD Ports

rtfm-1.0 - A FreeBSD documentation search mechanism

At FreeBSD Ports
NetBSD documentation and GNU Texinfo files search mechanism (At NetBSD packages collection)

txt2man-1.4.2 - Converts flat ASCII text to man page format

At FreeBSD Ports

info2html-1.1 - Translate GNU info files into HTML pages.

At FreeBSD Ports
info_to_html-0.9 - Translate GNU info files into HTML pages (At FreeBSD Ports)
info2html-1.1.tgz - translate GNU info files into HTML pages (At OpenBSD 2.7_packages i386)
info2html-1.1.tgz - translate GNU info files into HTML pages (At OpenBSD 2.8_packages i386)
info2html-1.1.tgz - translate GNU info files into HTML pages (At OpenBSD 2.7_packages sparc)
info2html-1.1.tgz - translate GNU info files into HTML pages (At OpenBSD 2.8_packages sparc)

trueprint-5.2 - Print program listings on postscript printer

At FreeBSD Ports

autodia-1.0_1 - Automatic Dia XML - from Source Code and Data

At FreeBSD Ports

help2man-1.26 - Automatically generating simple manual pages from program output

At FreeBSD Ports

man2html-3.0.1 - convert nroff(1) man pages to HTML

At FreeBSD Ports

code2html-0.9 - Sourcecode to HTML converter

At FreeBSD Ports

gtk-doc-0.9 - Code documentation system, originally for GTK+

At FreeBSD Ports

mkid - Program identifier database tools {oss}

At comp.sources.unix at ISC
mkid2mkid (At comp.sources.unix at UUNET)

faq-system - cgi package to manage one or more faq databases. {GPL}

(Info at freshmeat)

RoboHelp Office 2002


sourceit - A perl script for publishing source code examples on the Web {GPL}

OpenServer R5.0.4 Documentation Development System

Applications and Utilities

Others not displayed here
Full List

Related Subjects (default selections)

(The following links to subjects at this site retain your personalized selections.)

Object File Utilities - Object (already compiled) file utilities, libraries

Software Measurement and Metrics - Measurement of software for various uses

(There may be additional related subject pages listed here)

Personalized Selections
  GPL or LGPL.
Tip: To exclude choices, select all others in same column

Use our system: Bring Rapid Knowledge Transfer and Awareness to your company website!

Rapid-Links: Search | About | Comments | Submit Path: RocketAware > Activity specific > Software Development > Documentation >
RocketAware.com is a service of Mib Software
Copyright 2002, Forrest J. Cavalier III. All Rights Reserved.
We welcome submissions and comments