Introduction

 


IBM and eTSO formatting conventions


Language

Headings

Tables

Lists

File attachments

Creating and using graphics

Labeling graphics

Captions

Using colors

Emphasizing file names and text output from a program

Emphasizing important information: notes and warnings

 


IBM and eTSO writing standards


Action verbs in procedures

How to label common items

How to write procedures

  • Numbered items vs. bulleted items

  • Giving different options within a single step in a procedure

  • Providing reinforcement (i.e. the results of the user's actions)

  • Emphasizing items with which the user interacts

  • Actions involving submenus

  • Avoiding contractions

    Avoiding gender-specific terms

    Avoiding slang

    Avoiding abbreviations

    Referencing chapters, sections, or other documents

    Writing hyperlinks

    Including URLs as hyperlinks

    Referencing figures and tables

    Numbering figures and tables

    Disclosures and trademarks

    Y2K notice

    Things to delete from documents

    Titling documents

  • Documents in languages other than English

  • Ambra

  • Aptiva

  • CDT

  • Ispirati

  • Network Station: Hardware

  • Network Station: Software

  • OBI

  • Server

  • ThinkPad

  • Creating headings in documents

    Labeling versions, releases, and modification levels

    Capitalizing terms from a program

    Deciding how many spaces to put after sentence-final punctuation

    Using parentheses

    Using double-quotes

     


    Standards for form types


    General standards

    Parts information
        - Form type walkthrough

    Preloaded software information
        - Form type walkthrough

    Product information
        - Form type walkthrough

    Service hints and tips
        - Form type walkthrough

    Service publications
        - Form type walkthrough

    System support disks
        - Form type walkthrough

    Hot news

    FAQs

     


    Online Assistant standards (formerly Knowledge Base)


    Categories

     


    Essential grammar and usage tips


    Sentence construction

  • Writing a complete sentence

  • Recognizing relative phrases and subordinated sentences

  • Avoiding run-on sentences

  • Avoiding comma splices

  • Using participial phrases and avoiding dangling participles

  • Creating parallel structure

  • Verbs

  • Ensuring subject-verb agreement

  • Using proper verb tense

  • Punctuation

  • Using commas

  • Using semi-colons

  •  


    Essential writing tips


    Using active and passive verbs

    Avoiding nominalizations

    Writing clear and concise documents

     


    Writing for international audiences


    Style tips

    Grammar tips

    Terminology tips

    Punctuation tips