@(#)styleg.htm 3.3 03/10/01
The Generic UWF Maintenance Process (GUMP) 1994, 1995, 1996 The University of West Florida. All rights reserved.
Permission is granted to reproduce and adapt this document provided credit is given to the University of West Florida. This documentation is provided "as is" and no warranty of fitness for any particular purpose is made or implied.
This document is the Generic Style Guide which outlines the basic conventions and standards for the appearance of permanent text documents supporting the project for the generic maintenance process architecture for the University of West Florida. Documents will follow these conventions to the maximum extent possible in order to ensure a uniform appearance. This document itself is an example of these standards.
Follow the conventions and standards in this Style Guide when creating or modifying any GUMP document.
1.1.1 Storage Medium.
All GUMP documents should be under source control in SCCS. File names for GUMP documents should reflect the document title for ease of identification.
1.1.2 Document Processing Software
All references to text style and size correspond to standard HTML. Using WEB
tools to edit GUMP documents is absolutely not allowed. Only standard
HTML is authorized for GUMP documents. The use of the "<pre></pre>" preserve tag is not
encouraged because of the non-scalability of these, which is
contrary to the way most browsers display text. Most browsers allow text to
be scaled up or down based on the users preference.
1.2 FORMAT
GUMP documents should follow the following formatting guidelines.
1.2.1 Size and Orientation
Documents should be formatted to allow single-sided printing on standard
8.5 x 11 inch paper using portrait orientation. Figures and tables may use
either portrait or landscape orientation, but should use portrait orientation wherever possible (see paragraph 2.3.4).
1.2.2 Line Spacing
Line spacing should be single spacing.
1.2.3 Paragraph Numbering
GUMP paragraphs will be numbered using the style found in legal documents. Number the
sections (see paragraph 2.3.1.1) and paragraphs (see paragraph 2.3.1.2)
using the legal style.
1.2.4 Acronym Use
An acronym is a word formed usually from the first letter of each
major word in a term or phrase. Capitalize the letters in the acronym.
The acronym will succeed the full expansion of the term or phrase where
each significant letter of the term or phrase is boldfaced. When the first
use of the acronym appears in a document, enclose the acronym in parentheses.
After identifying the meaning of the acronym, subsequent use of the acronym
without parenthesis is acceptable. All acronyms will appear in a glossary
(see paragraph 2.4.4) at the end of the document.
Each document will have a title page with the following items. The title page for this guide should be used as a template.
2.1.1 Document Title
Use a unique descriptive name indicating the major purpose of the
document for the title. The document title will be all capital letters
in H1. Center all lines containing the document title.
2.1.2 Credits
The University of West Florida will be credited on the title page of all GUMP documents, no individual authorship will be placed on the front page of any document.
2.1.3 Document Date
Center the document date below the document title. Use the SCCS keywords for date and version.
2.1.4 Disclaimer
The permission and disclaimer clause printed on the title page of this guide will appear on the title page of all GUMP documents.
2.2 FRONT MATTER
The front matter appears in the following order: Abstract, Preface
(optional), Acknowledgments (optional), Table of Contents, List of Figures
(if any), and List of Tables (if any).
2.2.1 Abstract
An abstract is a brief summary of the major points presented
in the document, it is generally no longer than one or two paragraphs in length.
Center the uppercase boldfaced title "ABSTRACT" at the top of
the page. Do not number or indent the paragraphs in this section.
2.2.2 Preface
The use of a preface is optional. A preface is an introductory note
that includes the reasons for publishing the document, the
method of research, permission for the use of the material, and the anticipated
use of the document. Center the uppercase boldfaced title "PREFACE" at the top of
the page. Do not number or indent the paragraphs in this section.
2.2.3 Acknowledgments
The use of an acknowledgment is optional. An acknowledgment is a
written expression extending appreciation to those who assisted in the
preparation of the document. Center the uppercase boldfaced title "ACKNOWLEDGMENTS" at the top of
the page. Do not number or indent the paragraphs in this section.
2.2.4 Table of Contents
All documents will contain a table of contents with the title "TABLE
OF CONTENTS" centered at the top of each page in H2. All section
headings and paragraph headings appear in the table of contents. List headings
exactly as they appear in the report (see paragraph 2.3.1 and 2.3.2). All items in the table of contents will be implemented as HTML
links, using relative pathnames.
2.2.5 List of Figures
If the document contains figures, it must have a list of the
figures which are links to the referenced figure. Center the title "LIST OF FIGURES"
at the top of the page in uppercase bold print. Each figure entry must have a unique number and title. All items in the
list of figures will be implemented as HTML links, using relative
pathnames.
2.2.6 List of Tables
Documents containing tables must have a corresponding list of tables.
Center the title "LIST OF TABLES" in uppercase bold print at
the top of the page. Each table entry must have
a unique number and title. All items in the list of tables will be
implemented as HTML links to the referenced table, using relative pathnames.
2.3 DOCUMENT BODY
Divide the text into logically separate parts called sections. A section has a section heading containing
the section number and an appropriate title (e.g., 2.0 DOCUMENT COMPONENTS).
Subdivide sections into text paragraphs. The paragraph heading contains the paragraph
number followed by a corresponding title (e.g., 2.3 DOCUMENT BODY).
2.3.1 Numbering
All sections and paragraphs in the document will be numbered.
2.3.1.1 Section Numbering
All sections of the document will use the legal numbering system
to facilitate referencing. Sections are a combination of sequential leading
numbers followed by a decimal point and zero (e.g., 2.0, 3.0).
2.3.1.2 Paragraph Numbering
All paragraphs of the document will use the legal numbering system
to facilitate referencing. Number each paragraph using a combination of
integers and decimal points. Subdivide individual paragraph sections into
as many levels as necessary to describe their content. Do not use single
subsections. Major paragraph numbers consist of the leading section number,
a decimal point, and an integer representing the paragraph's hierarchical
placement. Subparagraph numbers consist of replicating the parent paragraph
number, a decimal point, and an integer representing the subparagraph's
hierarchical placement.
2.3.2 Titles
All sections and paragraphs in the document will have a title.
2.3.2.1 Section Titles
All section titles will be in uppercase H2 (e.g., 2.0 DOCUMENT COMPONENTS),
with all numbered section left justified on the page.
Headings that are not numbered, such as TABLE OF CONTENTS, GLOSSARY, etc.,
will be centered on the page.
2.3.2.2 Paragraph Titles
Major paragraph titles (e.g., 2.3 DOCUMENT BODY) appear in uppercase.
In subparagraph titles (e.g., 2.3.2 Titles) capitalize the first letter
of each major word. All numbered paragraphs should be left justified on the page.
2.3.3 Figures and
Tables
Imbed small tables and figures in the text following the paragraph
in which they are first referenced. Landscape orientation of tables and figures is permissible when it facilitates
readability. Sequentially number tables starting with table 1 (see Table
1). Label each table with the word "Table" followed by the table
number and the title. Label the figures in the same way as the tables replacing
the word table with figure (see Figure 1).
| Mythical Man Months | Mythical Men | Months |
|---|---|---|
| 10 | 4 | 2.5 |
| 12 | 6 | 2.0 |
| 3 | 14.3 | 0.2098 |
Cite references as they appear in the text with the author-date citation.
Citations contain the first four letters of the authors last name in capitals
followed by the last two digits of the year of publication. Enclose the
citation in brackets and place it immediately following the reference (e.g.,
[HUMP89] ). All references appear in the bibliography (see paragraph 2.4.3).
2.4 BACK MATTER
The back matter will appear in the following order: Revision History,
Appendices, Bibliography, and Glossary.
2.4.1 Revision History
Each document shall contain a description of the revisions that have
occurred to date. Capitalize and center the words "REVISION HISTORY"
in bold print at the top of the page. The first line of each narrative
contains the date of
the revision. The second line of each narrative identifies the author(s)
of the revision. The remaining lines of each narrative provide a brief
outline of the revision. The leading narrative will always be the most
current revision and will supersede previous narratives in reverse chronological
order.
2.4.2 Appendices
Designate appendices using capital letters starting with "A".
Capitalize and center the title "APPENDIX A" in bold print at
the top of the first page. Concatenate the word '(continued)' to the appendix
title if the appendix spans more than one page.
2.4.3 Bibliography
The bibliography contains a list of all the references cited by the
document. Capitalize and center the title "BIBLIOGRAPHY" in bold
print at the top of the page. Alphabetize references using the author-date
citation. An example of the format appears in the bibliography at the end
of this document. Title bibliographies that span more than one page use
the same techniques described in paragraph 2.4.2.
2.4.4 Glossary
A glossary is optional. If a glossary is included, it should contain a list of all the acronyms and unique terms
used in the document. Glossary entries appear in alphabetical order by
acronym. Capitalize and center the word "GLOSSARY" at the top
of the page. If the glossary spans more than one page, follow the guidelines
outlined for appendices in paragraph 2.4.2.
HUMP89
TAYL84