System Documentation

Eclectic Systems generally have a large amount of documentation, including:

  • man pages

  • community-specific documentation systems (e.g., perlinfo, texinfo)

  • papers and other package-specific documentation files

In addition, there are a number of external documentation resources:

  • printed matter (e.g., books, magazines)

  • web sites (e.g., community-specific, package-specific , or general)

Unfortunately, as detailed in The Documentation Problem, there are no consistent standards for file placement and naming, nor any global system for indexing this documentation. Consequently, merely locating (let alone formatting and printing) a given document can be a challenge.

Meta hopes to leverage XML's strengths in document management as a way to address these problems.

-- Main.RichMorin - 16 Jun 2003
Topic revision: r4 - 08 Jun 2003, WikiGuest
This site is powered by Foswiki Copyright © by the contributing authors. All material on this wiki is the property of the contributing authors.
Foswiki version v2.1.6, Release Foswiki-2.1.6, Plugin API version 2.4
Ideas, requests, problems regarding CFCL Wiki? Send us email