ArtsAutosBooksBusinessEducationEntertainmentFamilyFashionFoodGamesGenderHealthHolidaysHomeHubPagesPersonal FinancePetsPoliticsReligionSportsTechnologyTravel

Technical Communications Document Layout Procedures - Sample Guide

Updated on March 9, 2015

Front Matter

Front matter is divided into:

  • Cover
  • Inside of Front Cover

Cover

The cover is used as an identifier for most documents.

Components - Example

Component
Description
Paragraph Settings
Graphic and Text Logos
Located at the top of the page.
N/A
Main Title
Edit this to contain the document title, or major subject. For example, Tracker.
Arial 32, Bold, Right-justified
Subtitle
Contains a descriptive phrase or text that defines what part of the subject is covered in this document. For example, if the subject was Tracker, the subtitle might be, Troubleshooting Procedures.
Arial 22, Bold, Right-justified

Back of Front Cover - Example

Component
Description
Paragraph Settings
Title
Copyright Information
Paragraphs are left-justified. Font is Arial, Bold, 11pt.
Date Released
Date released - Example: Issued 06/03/2014
 
Legal Phraseology
Legal phrases - Example: All Rights of Use and Reproduction Reserved
 
Copyright
Copyright statement - Example: Copyright 2015
 
Author
Person who is responsible for document content - Example: Author, Mark Bush
 
Writer
Technical Writer that created the document - Example: Writer, K. Payne
 

Page Layout

Layout includes:

  • Page Setup
  • Orientation

Page Setup

The actual page layout (size, margins, etc.) is pre-determined. You should only change these settings in circumstances where a document contains extensive tables or other specific needs.

Orientation

Unless the layout demands, all document orientation should be portrait rather than landscape.

Chapters

Generally, the chapters listed in each document will be different. Each document will have at least:

  • A Table of Contents (TOC). Refer to the Post on Table of Contents
  • Document Overview or Scope
  • At least 1 body chapter
  • Glossary
  • An Index

Each document may also have an Appendix. Refer to the upcoming Post on Appendices.

Table of Contents (TOC)

Refer to the Post on Table of Contents.

Document Overview

Each chapter should contain a chapter entitled, Document Overview. The Document Overview contains introductory information, an overview of the document and the following sections:

  • Purpose
  • Audience
  • Layout

Purpose

This section contains information regarding the purpose of this document. It indicates if this is for reference use (e.g., Data Library), operations (e.g., User Guide), or other use.

Audience

The Audience section contains information regarding for whom the document was written. It also indicates any pre-requisites (i.e., knowledge, authorization, organizational level, etc.) for using the document.

Layout

This section contains a table that lists each chapter in the document and a brief description of each.

Body Chapter

Each chapter should contain introductory information, and the body of the chapter.

INTRODUCTORY INFORMATION

Each chapter should begin with a brief introduction that indicates the main topics discussed in that chapter. These topics are presented as bulleted items in a list.

Appendices

Appendices can be added as a chapter that immediately precedes the Glossary. Appendices are labeled with uppercase letters, A-ZZZ. Refer to the upcoming Post on Appendices.

Glossary

The Glossary contains a list of technical terms and definitions. Refer to the upcoming Post on the Glossary.

Index

Refer to the upcoming Post on Indexing.

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 a cloud services platform that we used to host our service. (Privacy Policy)
    CloudflareThis is a cloud CDN service that we use to efficiently deliver files required for our service to operate 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)
    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 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)
    Google YouTubeSome articles have YouTube videos embedded in them. (Privacy Policy)
    VimeoSome articles have Vimeo videos embedded in them. (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)
    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)
    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 advertisement 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)