Next / Previous / Contents / TCC Help System / NM Tech homepage

Abstract

Describes the recommended practices for external and internal documents related to the New Mexico Tech Computer Center.

This publication is available in Web form and also as a PDF document.

Table of Contents

1. Scope
2. Where things live
3. Software tools for document creation
3.1. DocBook
3.2. The PyStyler web content system
4. Style rationale
4.1. General style rules
4.2. Web presentation
4.3. Print presentation
5. The internal help system
5.1. When not to use MoinMoin
5.2. Limitations and problems of MoinMoin

1. Scope

These are guidelines for:

  • User-level and internal documentation for Tech Computer Center users and employees

  • Online and printed documentation

Note

Before we talk about the best tools for documentation, please keep in mind that any documentation is better than none. The TCC documentation staff will be happy to accept Word files, plain ASCII text, crayon on butcher paper, whatever. The important thing is to start with good information, in whatever form, and let the documentation staff worry about editing it and making it attractive.