Software documentation - CompWisdom
About us  |  Why use us?  |  Press  |  Contact us

 

Topic: Software documentation


  
 Software documentation - Wikipedia, the free encyclopedia
Software Documentation or Source Code Documentation is written text that accompanies computer software.
In the case of a software library, the code documents and user documents could be effectively equivalent and are worth conjoining, but for a general application this is not often true.
Documentation is an important part of software engineering that is often overlooked.
http://en.wikipedia.org/wiki/Software_documentation   (1533 words)

  
 Software and Documentation
Most managers and software engineers know that the majority of the cost of a software system is not in development but in maintenance.
The software developers who developed the buggy software that takes so much time to maintain should not be allowed to escape their creation.
Frequently the software is poorly designed and constructed and in almost every case the software is undocumented.
http://www.bearcave.com/software/prog_docs.html   (6021 words)

  
 NISTIR 4909: Software Quality Assurance: Documentation and Reviews
Description of system inputs to the software that may occur while the software is in use and may affect the software's interface with the user (e.g., inputs from a remote sensor).
Documentation for this phase should include the approval of the software for operational use and may include the user's manual, if installation and checkout is to performed by the end-user, rather than the vendor.
Today, as practitioners gain experience in software engineering and software quality, working groups for standards under revision are more carefully examining system-software relationships, requirements for software safety and computer security, differences in software test types, and the relationship between software development activities and software assurance activities.
http://hissa.nist.gov/publications/nistir4909   (14231 words)

  
 NASA Software Documentation Standard
The NASA Software Documentation Standard (hereinafter referred to as "Standard") is designed to support the documentation of all software developed for NASA; its goal is to provide a framework and model for recording the essential information needed throughout the development life cycle and maintenance of a software system.
The computer programs and data contained in the firmware are classified as software; the circuitry containing the computer program and data is classified as hardware.
Computer Software Unit (CSU) - The smallest logical entity specified in the design of a computer software component and the actual physical entity in code that implements a testable aspect of the requirements.
http://satc.gsfc.nasa.gov/assure/docstd.html   (4280 words)

  
 Software Documentation
In most cases that technical knowledge is operation of a specific piece of computer software or hardware and that audience is the person trying to use the same.
By the end of the course you should have a good idea of what writing software documentation entails and be able to approach software documentation projects logically.
People not in the field often fail to appreciate just how complex the process of writing documentation really is and how dependent it is on developers and other software professionals.
http://www.suite101.com/course.cfm/17509/seminar/542766   (292 words)

  
 The GNU Operating System
The Free Software Foundation (FSF) is the principal organizational sponsor of the GNU Project.
The GNU Project was launched in 1984 to develop a complete UNIX like operating system which is free software: the GNU system (GNU is a recursive acronym for “GNU's Not UNIX”; it is pronounced guh-noo, like canoe).
We support the FSF's mission to preserve, protect and promote the freedom to use, study, copy, modify, and redistribute computer software, and to defend the rights of Free Software users.
http://www.gnu.org   (482 words)

  
 Pikauba Software - Application Documentation Solutions
DBDocumentor takes the majority of the pain out of database documentation by providing a framework where developers can annotate the database as it is being developed, and produce the resultant documentation in a matter of minutes, or as part of any build process.
Pikauba Software solutions help software developers, QA professionals, information architects and project managers develop world class applications through source code documentation technologies.
By producing the documentation defining the purpose of the procedure and doing so in a manner that allows developers to code against the procedure as it's being developed can shorten development times dramatically.
http://www.pikauba.com   (691 words)

  
 Software Learning & Documentation Project
What might be more important is your ability to learn new software and technologies as they continue to rapidly change.
The presentation will, in part, be evaluated on whether or not it reaches the other teams and enables them to complete the defined tasks.
The presentation provides the relevant information about the task/technology needed to use the documentation later to complete the task.
http://core.ecu.edu/engl/eblem/3880_eleven/Software_Learning_11.htm   (740 words)

  
 ISO/IEC JTC1/SC7/WG2 web page
WG2 is tasked with developing international standards in the area of software systems documentation, and is part of a structure formed under ISO and the IEC.
ISO/IEC 9127 has been available for some time, and details a minimum set of information that should be visible on the outside of a shrink-wrapped software package, and also the minimum information available in the enclosed documentation.
It describes how to establish what information users need, how to determine the way in which that information should be presented to the users, and how then to prepare the information and make it available.
http://www.hci.com.au/iso   (409 words)

  
 Software Documentation Weblog Archives
For documentation, there is the dissertation of the author and the specification of the output format.
Although the software is in early stages, it is very interesting to see a completely new approach to XML editing.
JabRef (Screenshots) is a promising piece of software that will help you to manage a bibliographical database.
http://www.goshaky.com/archive.html   (12981 words)

  
 Software Documentation
View the technical documentation for the currently available JDK and related software for the Java™ platform.
To download the software, visit our software download page.
If you have any questions about our software products for the Java platform, please refer to the frequently asked questions.
http://h18012.www1.hp.com/java/documentation   (83 words)

  
 Software Documentation Is Like Weather and Pornography
Mark Johnson is a software developer, trainer, writer, and speaker living in Silver Spring, MD. He works at the National Center for Biotechnology Information, writing documentation and tools for open-source bioinformatics software.
Good software documentation is like pornography: it's hard to define, but
What behavior would you want from a customizable API documentation interface?
http://www.artima.com/weblogs/viewpost.jsp?thread=35019   (432 words)

  
 Intel® NetStructure™ SS7 Products Software & Documentation
The Host Protocol Software section includes protocol binaries for Windows*, Linux* and Solaris* and the corresponding Release Notes.
The SS7 Software and Documentation contains all the software and documentation required by a user to use the following Intel® products:
The website is divided into Product Specific, Generic Information and Host Protocol Software.
http://resource.intel.com/telecom/support/ss7/downloads   (244 words)

  
 Software Documentation
Object-Oriented Data Analysis Software Concept - A. Csillaghy
RHESSI Data Analysis Software Change History - K. Tolbert
Data Analysis Software Frequently Asked Questions (FAQs) - K. Tolbert
http://hesperia.gsfc.nasa.gov/rhessidatacenter/software/documentation.html   (191 words)

  
 Documentation for GNU Software
Here are documentation trees for most of the GNU Project software packages.
The GNU Project has recently disavowed all knowledge of some of these packages, and they are now available as a sub-tree of the GNU mirror itself, in the non-gnu directory.
stow - Managing the Installation of Software Packages, v.1.3.2
http://www.sunsite.ualberta.ca/Documentation/Gnu   (485 words)

  
 Run II Offline computing and software - software documentation
Run II Offline computing and software - software documentation
How to use Adobe PostScript language files properly
http://www-cdf.fnal.gov/upgrades/computing/computing_softb2.html   (33 words)

  
 GNOME Handbook of Writing Software Documentation V1.0.2
GNOME developers, packagers, and translators may not be writing GNOME documentation but will want to understand how the GNOME documentation system works and will need to collaborate with GDP members.
Feel free to introduce yourself on the gnome-doc-list mailing list and indicate which project you intend to work on, or else ask for suggestions of important documents which need work done.
You can find a copy of the GFDL at this link or in the file COPYING-DOCS distributed with this manual.
http://developer.gnome.org/projects/gdp/handbook/gdp-handbook   (768 words)

  
 imake-Related Software and Documentation
The software distribution is available as a gzip'ed or compress'ed tar file.
There is also an accompanying software distribution that contains fixed utilities and configuration file patches.
This directory contains miscellaneous imake documentation, utilities, and configuration files.
http://www.snake.net/software/imake-stuff   (570 words)

  
 [No title]
Start creating professional Help systems and documentation for web-based and desktop software applications...
Creating a software manual with RoboAuthor is really a snap!
Get RoboAuthor, the fastest visual HTMLHelp (.CHM) and WinHelp (.HLP) creator software available on the market.
http://www.roboauthor.com   (807 words)

  
 SQAtester.com - Software Testing Documentation and Strategy
An extremely practical and cost effective Web Based Bug Tracking Software and help desk software ready to be integrated into company intranet today.
Have Something to Share: software testing tip, interesting bug, or
: Oracle DBA, Cisco Networking, Software Testing and Programming.
http://www.sqatester.com/documentation   (325 words)

  
 GNU Documentation
If you want this documentation in other formats, use the texinfo files within each package to generate them, as I did, or check each section for downloadable *.tgz files.
Copyright © 2003 by The Free Software Foundation
If you would like to have a local copy of these files, please
http://www.delorie.com/gnu/docs   (99 words)

  
 Linux.com: The Enterprise Linux Resource
In 2006, Canadians can fill out their census forms online for the first time -- but not if they use GNU/Linux, or are free software advocates who prefer not to install a proprietary version of Java.
Desktop Software Tools & Utilities Graphics & Multimedia
The situation raises questions of open access to government that are familiar to most of the free and open source software (FOSS) communities, all the more so because other government services are implementing systems with the same limitations.
http://www.linux.com   (662 words)

  
 Catalyst 6500 Series Switches
Hardware and software documentation for the Catalyst 6006, 6503, 6506, 6009, 6509, 6509-NEB, and 6513 switches.
Catalyst 6500 Series Cisco IOS Software Documentation, 12.1E
Catalyst 6500 Series Cisco IOS Software Documentation, 12.2SX
http://www.cisco.com/univercd/cc/td/doc/product/lan/cat6000   (162 words)

  
 3Com Software and Documentation Search
You can search for software and documentation four ways:
Use this section to either find a file by name or to do a more general listing.
To find software for the 3Com Superstack Switch 5500, enter "3CR17151" or "5500".
http://www.3com.com/products/en_US/downloadsindex.jsp   (132 words)

  
 GNU Free Documentation License - GNU Project - Free Software Foundation (FSF)
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does.
It complements the GNU General Public License, which is a copyleft license designed for free software.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
http://www.gnu.org/copyleft/fdl.html   (2767 words)

  
 Software Documentation
Reciprocal Net is funded by the U.S. National Science Foundation as part of the National Science Digital Library project.
Reciprocal Net > Site Network > Software Documentation
Client platforms known to be compatible with Reciprocal Net site software
http://www.reciprocalnet.org/networkinfo/docs   (75 words)

  
 Juniper Networks :: Technical Documentation :: Software
A summary of the titles and contents of the JUNOSe software documentation for E-series edge router platforms.
A summary of the titles and contents of the JUNOS software documentation for J-series, M-series, and T-series routing platforms.
Home > Support > Technical Documentation > Software
http://www.juniper.net/techpubs/software   (177 words)

  
 Ghostscript, Ghostview and GSview
Welcome to the Home Page for Ghostscript, an interpreter for the PostScript language and for PDF, and related software and documentation.
Last updated $Date: 2006-02-24 22:56:20 -0600 (Fri, 24 Feb 2006) $ Corrections to the Ghostscript WWW pages should be mailed to Russell Lang
http://www.cs.wisc.edu/~ghost   (89 words)

  
 Home
Through software engineering we provide a suite of software documentation solutions such as our E-GEN suite of products for Enterprise Systems, Online Documentation for IBM mainframe, Flowchart Software and Process Flowcharting solutions for the large OS/390 Data centers and a JCL Syntax Checker for OS/390 JCL validation.
These tools, based on a new repository technology, help dramatically leverage a company's sizable investment in its information system, its competitiveness and its know-how.
To provide time and money savings with Enterprise Wide Information System Documentation and Application Stream Generation solutions for large companies running their business on MVS, OS/390, Z/OS mainframes and complex environments.
http://www.iscsoftware.com   (189 words)

  
 J2SE Documentation
- Sun's Java Series books are written by members of the Java Software Engineering team.
Documentation for other Java APIs and products can be found at J2EE, J2ME and other Java documentation.
Get clear, how-to information about the Java platform, with hundreds of example programs.
http://java.sun.com/docs   (202 words)

  
 Allied Telesyn, Inc. - Service/Support: Software / Documentation
Select a product below for a comprehensive list of software, patches,
Allied Telesyn, Inc. - Service/Support: Software / Documentation
Allied Telesyn's 10 most recent software releases and updates:
http://www.alliedtelesyn.com/support/software/default.aspx   (75 words)

  
 Safe Software Download Centre
Safe Software technology is embedded into over 500,000 products that are shipped?
82 KB Safe Software technology is embedded into over 500,000 products that are shipped?
724 KB Safe Software and ArcIMS Data Delivery
http://www.safe.com/support/downloads/index.php   (215 words)

  
 CrayDoc 4.03
Cray customers can order CrayDoc server software and documentation by contacting the Cray Software Distribution Center by e-mail at orderdsk@cray.com or by telephone at 1-800-284-2729, extension 605-9100.
This site contains public technical product documentation published by Cray Inc. Some documents that are listed here may not be publicly available.
For information about obtaining nonpublic documents, contact your Cray representative.
http://docs.cray.com   (68 words)

  
 W3C Software License
Free Software Foundation's assessment of GPL compatibility and
W3C Software Short Notice should be included (hypertext is preferred, text is permitted) within the body of any redistributed or derivative code.
This work (and included software, documentation such as READMEs, or other related items) is being provided by the copyright holders under the following license.
http://www.w3.org/Consortium/Legal/copyright-software.html   (424 words)

  
 Physical Therapy Documentation Software - Home
Welcome to The Rehab Documentation Company, Inc the maker of ReDoc Software.
We help physical and occupational therapists, and speech pathologists in all settings apply information technology to solve their clinical documentation, workflow and business issues.
By doing so, ReDoc helps therapists and their facilities maximize efficiency, productivity and quality of care.
http://rehabdocumentation.com   (85 words)

  
 Cisco IOS Software Configuration
Cisco CRS-1 and IOS XR Software Documentation, Release 3.2
http://www.cisco.com/univercd/cc/td/doc/product/software   (21 words)

  
 CLEO Software Documentation Home Page
CLEO II.5 SVX Homepage - includes description of SVX software.
This area documents some topics concerning CLEO-II software.
Very useful for finding the common block that you need to compile your routine !
http://www.lns.cornell.edu/public/CLEO/soft   (209 words)

  
 Apache HTTP Server Version 2.0 Documentation - Apache HTTP Server
Copyright 1995-2006 The Apache Software Foundation or its licensors, as applicable.
Apache HTTP Server Version 2.0 Documentation - Apache HTTP Server
http://httpd.apache.org/docs/2.0   (21 words)

  
 JMF 2.1.1 Software Documentation
Developers Home > Products & Technologies > Java Technology > J2SE > Desktop Java > JMF > Reference > Documentation >
Unless otherwise licensed, code in all technical manuals herein (including articles, FAQs, samples) is provided under this License.
http://java.sun.com/products/java-media/jmf/2.1.1/documentation.html   (68 words)

  
 State Software Documentation
Here you can choose to browse, search, or print the latest versions of the OECN and State Software Documentation interactively.
Most of the documentation is available in two different formats - HTML and PDF.
Click below on the format of your choice.
http://ssdt.oecn.k12.oh.us/on-line.htm   (55 words)

  
 IBM Software Support : Rational
Below are links to all current Rational product documentation such as product manuals, white papers, redbooks, and education documents.
Online manuals, install guides and additional documentation for previous releases are available for viewing or downloading by following the specific IBM Rational product links below.
Legacy Rational product documentation - Online manuals, install guides and additional documentation for legacy releases are available at the bottom of this page.
http://www-306.ibm.com/software/rational/support/documentation   (92 words)

  
 Screen Reading Software Documentation
Install this program and then look in the Help folder to find the product documentation.
If you want to view documentation for earlier versions of JAWS, visit the Additional JAWS for Windows Downloads page and download the appropriate JAWS version.
http://www.freedomscientific.com/fs_support/doc_screenreaders.asp   (40 words)

  
 IBM Lotus software: Lotus Documentation
You can read some of the documentation online, or you can download the files for printing or viewing.
Lotus Documentation features all documentation for Lotus products, such as Notes, Domino Designer, and Domino, and the extended products such as Lotus Sametime, LotusScript, and Lotus Domino Document Manager.
developerWorks > Lotus > Technical Library > Lotus Documentation
http://www-10.lotus.com/ldd/doc   (64 words)

  
 BakBone Software - Product Documentation
Product datasheets, technical documentation and whitepapers are available for download.
http://www.bakbone.com/support/product_documentation   (20 words)

Compwisdom
 About us   |  Why use us?   |  Press   |  Contact us

 Copyright © 2006 CompWisdom.com Usage implies agreement with terms.