ArtsAutosBooksBusinessEducationEntertainmentFamilyFashionFoodGamesGenderHealthHolidaysHomeHubPagesPersonal FinancePetsPoliticsReligionSportsTechnologyTravel
  • »
  • Books, Literature, and Writing»
  • How to Write

Technical Communications Text and Paragraph Formatting Procedures - Sample Guide

Updated on May 3, 2015

Text Conventions

Conventions are commonly used phrases, or reference methods.

Conventions

Topic
Description
Acronyms
When using the acronym for the first time, use the complete term, then display the acronym in parentheses ( ).
Case
Use the following formats for these terms: Internet, and email.
Caution
Anything that may endanger the user, an application, or a device, should be discussed in a caution. CAUTION should be uppercased, bolded and red. Add a colon (:). The actual information in the note should be italicized. Example: CAUTION: This only applies to this screen.
Color
All text must be shown in black, with the exception of Cautions, which are shown in red.
Compound Phrases
Use the following compound words: Website, Webmaster, Database, Filename.
Consistency
Always be consistent. What ever terms or approach that you use, use it throughout the document.
Contractions
Do not use contractions such as don't, isn't, can't, etc.
Cross References
Whenever another section is referenced, or discussed, include the text in italics.
Fields
Refer to fields using the exact field label. Field label text is shown in bold, 10 pt Arial. Example: In the Name field… The exception to this would be fields discussed in a table. Due to limited space, bold the label, but leave it at 9 pt. Arial.
Gender
Use the term the user, rather than he/she. Use the term their, rather than his or hers, to indicate possession. Example: The user must enter their proper login and password.
Headings/Subheadings
Keep headings as short as possible. Always insert text between headings.
Keyboard Keys
Keys should be shown in brackets. Tagged with Arial 9 bold. Example: Press [ENTER].
Notes
Any information to be added to a topic should be tagged as a Note. NOTE should be uppercased, bolded. Add a colon (:). The actual information in the note should be italicized. Example: NOTE: This only applies to this screen.
Page Breaks
Page breaks should be used to manually start a new page, rather than manually forcing a new page by entering numerous returns [Enter]s. Page breaks should always be inserted before a Heading 1 paragraph. Page breaks should always be inserted if 1 or 2 lines in a paragraph are widowed or orphaned. Insert a page break in front of the paragraph.
Plural
When using acronyms such as PC simply add an s to indicate more than 1. Example: PCs
Positions, Titles, or Departments
When referencing a specific position, title or department, enter them with initial uppercase letters. For generic references to these words, enter the words in lowercase letters.
Sentence Structure
Keep sentences and paragraphs short. Maximum of 3 sentences per paragraph.
Slang
Do not use slang. Always use professional grammar.
Steps (procedures)
Each step is to contain 1 command or action. The result of that action is discussed in the same step. Screen shots are shown below the step. Example: 1. Select Tools from the toolbar. The toolbar menu, shown below, displays. (Menu is inserted here.)
Term to be Defined
A term to be defined is shown in 10 pt. Arial italics. Example: Radio Frequency refers to …
Terminology and Definitions
When using an important or technical term for the first time, italicize the text.
Third Person Use
Third person (you, your, etc.) is acceptable.
Typed Information
Information that the user is to type in is shown in 9 pt. Arial, bold. Example: Type sh – le.
White Space
Use white space for clarity and organization.

Paragraph Tags

Use paragraph tags that have been established to format text and paragraph settings. The following table contains a list of common paragraph tags and descriptions.

Comments

    0 of 8192 characters used
    Post Comment

    No comments yet.

    working

    This website uses cookies

    As a user in the EEA, your approval is needed on a few things. To provide a better website experience, hubpages.com uses cookies (and other similar technologies) and may collect, process, and share personal data. Please choose which areas of our service you consent to our doing so.

    For more information on managing or withdrawing consents and how we handle data, visit our Privacy Policy at: "https://hubpages.com/privacy-policy#gdpr"

    Show Details
    Necessary
    HubPages Device IDThis is used to identify particular browsers or devices when the access the service, and is used for security reasons.
    LoginThis is necessary to sign in to the HubPages Service.
    Google RecaptchaThis is used to prevent bots and spam. (Privacy Policy)
    AkismetThis is used to detect comment spam. (Privacy Policy)
    HubPages Google AnalyticsThis is used to provide data on traffic to our website, all personally identifyable data is anonymized. (Privacy Policy)
    HubPages Traffic PixelThis is used to collect data on traffic to articles and other pages on our site. Unless you are signed in to a HubPages account, all personally identifiable information is anonymized.
    Amazon Web ServicesThis is used to collect data on traffic to articles and other pages on our site. Unless you are signed in to a HubPages account, all personally identifiable information is anonymized. (Privacy Policy)
    CloudflareThis is used to quickly and efficiently deliver files such as javascript, cascading style sheets, images, and videos. (Privacy Policy)
    Google Hosted LibrariesJavascript software libraries such as jQuery are loaded at endpoints on the googleapis.com or gstatic.com domains, for performance and efficiency reasons. (Privacy Policy)
    Facebook LoginYou can use this to streamline signing up for, or signing in to your Hubpages account. No data is shared with Facebook unless you engage with this feature. (Privacy Policy)
    PaypalThis is used for a registered author who enrolls in the HubPages Earnings program and requests to be paid via PayPal. No data is shared with Paypal unless you engage with this feature. (Privacy Policy)
    Google AdSense Host APIThis service allows you to sign up for or associate a Google AdSense account with HubPages, so that you can earn money from ads on your articles. No data is shared unless you engage with this feature. (Privacy Policy)
    Features
    Google Custom SearchThis is feature allows you to search the site. (Privacy Policy)
    Google MapsSome articles have Google Maps embedded in them. (Privacy Policy)
    Google ChartsThis is used to display charts and graphs on articles and the author center. (Privacy Policy)
    Google YouTubeSome articles have YouTube videos embedded in them. (Privacy Policy)
    VimeoSome articles have Vimeo videos embedded in them. (Privacy Policy)
    MavenThis supports the Maven widget and search functionality. (Privacy Policy)
    Marketing
    Google AdSenseThis is an ad network. (Privacy Policy)
    Google DoubleClickGoogle provides ad serving technology and runs an ad network. (Privacy Policy)
    Index ExchangeThis is an ad network. (Privacy Policy)
    SovrnThis is an ad network. (Privacy Policy)
    Facebook AdsThis is an ad network. (Privacy Policy)
    Amazon Unified Ad MarketplaceThis is an ad network. (Privacy Policy)
    AppNexusThis is an ad network. (Privacy Policy)
    OpenxThis is an ad network. (Privacy Policy)
    Rubicon ProjectThis is an ad network. (Privacy Policy)
    TripleLiftThis is an ad network. (Privacy Policy)
    Say MediaWe partner with Say Media to deliver ad campaigns on our sites. (Privacy Policy)
    Remarketing PixelsWe may use remarketing pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to advertise the HubPages Service to people that have visited our sites.
    Conversion Tracking PixelsWe may use conversion tracking pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to identify when an advertisements has successfully resulted in the desired action, such as signing up for the HubPages Service or publishing an article on the HubPages Service.
    Statistics
    Author Google AnalyticsThis is used to provide traffic data and reports to the authors of articles on the HubPages Service. (Privacy Policy)
    ComscoreComScore is a media measurement and analytics company providing marketing data and analytics to enterprises, media and advertising agencies, and publishers. Non-consent will result in ComScore only processing obfuscated personal data. (Privacy Policy)
    Amazon Tracking PixelSome articles display amazon products as part of the Amazon Affiliate program, this pixel provides traffic statistics for those products (Privacy Policy)