DEC STD 143

Standard for Updating Hardware Software Manuals

Order Number: EL-00143-00

DEC Standard 143 outlines the official format and procedures for updating Digital Equipment Corporation (DEC) hardware and software manuals.

The standard was established to address user dissatisfaction and internal difficulties caused by previous, less formal update methods (e.g., manual pen-and-ink changes). Its primary goals are to make manual updates easier for customers to use and for writers to maintain.

Key aspects defined by the standard include:

  • Terminology: It clarifies that an "update" is a partial change, while a "revision" is a total replacement of a manual. Terms like "addendum" and "change notice" are not officially recognized.
  • Update Format: Updates are published as complete replacement or additional pages. New/changed pages are identified by a "month year" date and, if applicable, a software system version number. Specific changes on a page are marked by a vertical "change bar" in the outside margin, while entirely new pages do not use change bars but are identified by date/version. Deletions are indicated by a bullet in the margin.
  • Page Numbering: To manage text overflow from updates without re-paginating entire chapters, "point pages" (e.g., "2-16.1") are introduced to contain the overflowing text.
  • Administrative Procedures:
    • Each update includes an "Update Notice Page" providing instructions, an abstract of changes, and lists of old and new pages.
    • Updates receive a specific order number derived from the manual's original number, with a suffix indicating the update sequence.
    • The standard provides guidelines for when an "update" is sufficient versus when a complete "revision" (e.g., if over 30% of replacement pages are needed) is more appropriate, with the documentation supervisor making the final decision.
    • When manuals are reprinted with previously issued updates, the updates are incorporated, and the manual's order number is appended with codes (e.g., "DN1, DN2") to reflect this, while the Update Notice page is removed.

The standard applies to all hardware and software manuals produced by DEC's documentation groups, with the exception of certain perfect-bound handbooks not intended for updates. It does not dictate methods for broader distribution of updates (e.g., monthly packages).

EL-00143-00
August 1976
10 pages
Quality

Original
0.2MB

Site structure and layout ©2025 Majenko Technologies