KEMBAR78
Internal Document Style Guide | PDF | Policy | Paragraph
100% found this document useful (1 vote)
148 views8 pages

Internal Document Style Guide

This document provides guidelines for formatting and structuring various types of documentation including policies, procedures, guidelines, standards, and processes. It addresses topics such as fonts, headings, numbering, tables, notes, and other stylistic elements. The goal is to establish consistency across documents to make them easily recognizable and enhance readability. Document control numbers are assigned based on a standardized numbering system tied to the associated policy. The release number configuration specifies how to indicate major versus minor changes between versions.

Uploaded by

subagja
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
100% found this document useful (1 vote)
148 views8 pages

Internal Document Style Guide

This document provides guidelines for formatting and structuring various types of documentation including policies, procedures, guidelines, standards, and processes. It addresses topics such as fonts, headings, numbering, tables, notes, and other stylistic elements. The goal is to establish consistency across documents to make them easily recognizable and enhance readability. Document control numbers are assigned based on a standardized numbering system tied to the associated policy. The release number configuration specifies how to indicate major versus minor changes between versions.

Uploaded by

subagja
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 8

 

 
 
 
 
 
 
Document Style Guide   
 

 
 

Table of Contents 
Overview ................................................................................................................................................. 3 
Cover Page .............................................................................................................................................. 3 
Release Number ..................................................................................................................................... 3 
Document Control Number .................................................................................................................... 4 
Fonts ....................................................................................................................................................... 4 
Headings ............................................................................................................................................. 4 
Paragraphs .......................................................................................................................................... 4 
Headers / Footers ............................................................................................................................... 4 
Title Page ............................................................................................................................................ 4 
Text Colours ............................................................................................................................................ 5 
Margins ................................................................................................................................................... 5 
Headers / Footers ................................................................................................................................... 5 
Table of Contents ................................................................................................................................... 5 
Spacing .................................................................................................................................................... 6 
Tables ...................................................................................................................................................... 6 
Numbering / Bullets ............................................................................................................................... 7 
Notes / Caution / Important References ............................................................................................... 8 
Other Considerations ............................................................................................................................. 8 
 
 

2 | Page   INTERNAL USE ONLY   Document Style Guide 


 

 
Overview  
This Style Guide contains documentation standards for developing Policies, Guidelines, Procedures, Standards 
and  Process  documentation.  The  information  in  this  guide  should  be  followed  when  creating  any  of  these 
documents for internal distribution.  
The format of the title page used in this Style Guide should be followed when developing any of the document 
types referenced above.  
 
 
Cover Page  
The format and content of the Cover page depicted in this Style Guide should be followed when developing 
any of the document types referenced in the Overview. The “Sponsor” field should contain the name of the 
business unit or functional department responsible for the information in the document. It should not contain 
a person’s name.  
The Prepared By and Approved By fields should contain the name of the applicable individual.  
The Origination Date should be the date when the document was approved for the first time. This date should 
never be changed. The Current Release Date should contain the date that this specific release was approved. 
This date will change as new releases are issued. The Current Release Date field should correspond with the 
most recent date in the Release History table.  
The  Document  Control  Number  (DCN)  should  be  assigned  when  the  original  document  is  written.  This  field 
should not change once the number has been assigned.  
The  Release  Number  should  be  updated  to  correspond  with  the  latest  number  referenced  in  the  Release 
History table. See the Document Control Standards for details on the numbering scheme.  
 
Release Number  
The  Release  Number  configuration  consists  of  whole  number  with  a  single  digit  to  the  right  of  the  decimal 
point. The whole number to the left of the decimal indicates a major change to the document. For example a 
complete rewrite of the content because the process or procedure or policy or guideline completely changed; 
or there was a significant change to the process that impacted how the activity was managed.  
The single digit to the right of the decimal indicates a minor change to the document since its last issue date. 
For example a process step was added; or an activity was updated on a procedure; or a new form was included 
in the document reference.  
Each time the document is reissued the DCN number must be updated. Usually the update only impacts the 
number  to  the  right  of  the  decimal  and  not  the  whole  number  to  the  left.  The  update  should  only  be 
incremented by one number at a time. For example, version 1.0 is updated to 1.1 or version 2.3 is updated to 
2.4.  As  indicated  above,  if  the  change  constitutes  a  major  shift  in  the  document  then  the  version  number 
would change from 1.0 to 2.0 or 1.5 to 2.0. Whenever there is a major change to the DCN the new DCN always 
starts with “x.0” (where x is the next sequential whole number (1, 2, 3 etc.). The first decimal number should 
always start with 0 zero when there is a major change in the document that results in the whole number being 
updated to the next incremental number.  
During the document review process, if there are several reviews and subsequent revisions before the updates 
are  approved,  it  is  recommended  that  a  second  digit  to  the  right  of  the  decimal  be  used  to  track  all  of  the 
various review cycles. For example, when going from 1.0 to 1.1 there may be several reviews requiring tracking 
versions  (1.11,  1.12,  1.13,  etc).  However,  once  the  document  is  approved  the  second  decimal  number  is 
dropped from the final document so it is issued as version 1.1 for the functional audience to use.  

3 | Page   INTERNAL USE ONLY   Document Style Guide 


 

 
Document Control Number  
The Document Control Number (DCN) is assigned based on the type of document. Policies are assumed to be 
the primary driver behind the document structure; therefore the numbering scheme is based on this premise. 
There  are  five  document  types  assigned  control  numbers:  Policies,  Guidelines,  Procedures,  Processes  and 
Standards. The control number configuration is six digits in length divided into two 3‐digit sections. The first 
3‐digit number references the Policy and the second 3‐digits will indicate one of the other four types linked to 
the  Policy.  Each  sub  document  type  has  a  group  number  assigned  that  allows  for  200  documents  to  be 
associated with a specific Policy.  
• 100 = Policies  
• 200 = Guidelines  
• 400 = Procedures  
• 600 = Processes  
• 800 = Standards  
This  is  an  example  of  a  DCN  number  assigned  to  the  first  policy  and  associated  guidelines:  101.201;  or  a 
Procedure DCN would contain this configuration: 101.401. If a document is associated to all policies as in the 
case of the Policy Exception Procedure the Policy number is “100” indicating all policies, followed by the sub 
section  identifying  the  specific  document  type.  For  example  the  Policy  Exception  procedure  number  is: 
100.401 where “4” designates a procedure and “1” indicates the first procedure associated to that policy.  
In situations where a sub document applies to more than one policy, the assignment is made to the policy with 
the most impact. Subsequent policies where that document applies will contain a reference to the DCN and 
title.  
 

Fonts  
Headings  
Section headings should use Calibri, Bold.  
• Heading 1 = 12 point size / small caps  
• Heading 2 = 10 point size  
• Heading 3 = 10 point size  
If additional sub‐ headings are required use the same font style as Heading 3.  
Heading 1 should not be indented. However, each subsequent sub heading should be indented such that the 
text begins directly under the beginning of the previous heading’s text.  
 
Paragraphs  
All text within the document should use Calibri, 10 point, Regular.  
Exception – use Calibri, 10 point, Bold when creating table headings.  
 
Headers / Footers  
Use Calibri, 8 point, Regular.  
 
Title Page  
Document titles should use Calibri, 24 point, Bold.  
Sub‐titles should use Calibri, 16 point, Bold.  

4 | Page   INTERNAL USE ONLY   Document Style Guide 


 

 
Text Colours  
Generally text colour should be set to automatic which will result in a black type face.  
Under special circumstances when colouring text for highlighting purposes it is recommended that bold type 
face be used with black. However if colouring the text is preferred the individual may select any appropriate 
colour keeping in mind that the colour needs to be visible if the document is printed on a black/white printer.  
 
Margins  
Page margins should be 1 inch on all four (4) sides.  
 
Headers / Footers  
Headers should contain the company logo in the left corner and the page number in the right corner.  
Footers should contain the appropriate document classification in the left corner and the document title in the 
right corner using standard formatting as indicated in this document. There are 3 document classifications that 
may be used depending on the content of the material:  
• EYES ONLY (all caps / red): This classification is for “secret” material that has a limited 
audience.  
• INTERNAL USE ONLY (all caps / blue): This classification is for confidential material that has a 
specific audience.  
• GENERAL USE (all caps / green): This classification is for general purpose material that may be 
disseminated to anyone in the company.  
A 1/2 point line should appear below the header content and above the footer content to indicate separation 
between these sections and the body of the document.  
It is recommended that both the header and footer be constructed using a two column, single row table so 
that it will automatically expand and contract with the page display (landscape vs. portrait). Additionally, the 
separation line in the header and footer should be linked to a carriage return (2 point Calibri) instead of the 
table format itself. This will enable the author to place the header information exactly at the beginning and 
end of the lines at the margin break.  
Some document formats allow for a title in the header. This information should be displayed using Calibri, 12 
point Bold font. When a title is placed in the header, move the page numbers to the footer under the file 
name.  
 
Table of Contents  
A table of contents is optional. However, when using a table of contents the following applies.  
• Font = Calibri, 10 point  
• Level One Heading is Bold face  
• Level Two Heading is Regular face  
• Level Three Heading is Italic face  
• Spacing between lines should be set at 1 ½ in the Paragraph window with Before / After set 
to zero.  
 

5 | Page   INTERNAL USE ONLY   Document Style Guide 


 

 
Spacing  
All spacing should be set using the Paragraph feature for the body of the document and the Styles feature for 
headings.  
• Headings – 12 point, Before / 3 point, After.  
• Text – 6 point Before and After  
• Tables:  
o Rows – 3 point Before and After text  
o Spacing between the last sentence and the beginning of a table should be set to 12 
point.  
o A single carriage return should be used to separate the end of the table from the next 
content in the document. This carriage return should have the paragraph spacing 
Before and After set to zero.  
• Bullets – 3 point Before and After  
 
• Header / Footer – 3 point Before and After  
 
Tables  
Tables may be constructed in several different styles. Generally tables should be created using lines to 
separate the cells as indicated in this example.  

Document Type  Number  Title 

   

POLICIES     

   

   

GUIDELINES     

   

   

STANDARDS     

   

 
 
 

6 | Page   INTERNAL USE ONLY   Document Style Guide 


 

 
However, other styles are also acceptable depending on the impact attempting to be conveyed. For example:  

Retention Period 
Function / Record  Regulation / Citation 
(In years) 

Corporate and Genera;     

Capital Stock Records     

Capital Stock Ledgers  Maintain; DO  17CFR250.26 

Stubs of Capital Stock Insurance  06 after cancellation  17CFR240.17A(d) 

Stock Transfer Registers  01 yr after transfer  17CFR240.17Ad‐7c 

Cancelled Stock Certificates  06 after cancelation  17CFR 240.17Ad‐6 

Bonds of Indemnity and affidavits  03  17CFR240.17F1 


covering issuance of stock 
 
certificates to replace lost 
certificates 

 
Font size within a table can be changed to accommodate the row and column spacing. However, 8 point 
regular should only be used as a last resort. 10 point regular should be used whenever possible.  
Heading text is generally displayed in black type face. However white type face can be used if the row colour is 
too dark as in the first example above. This decision is at the discretion of the document creator.  
The line style is optional. However, the default is a solid line a ½ point width. 
 
Numbering / Bullets  
When  using  numbering,  it  is  recommended  that  a  Style  be  created  to  manage  the  automatic  sequencing 
usually  needed  with  this  feature.  The  style  to  be  used  is  left  to  the  discretion  of  the  document  creator, 
however it is recommended to use numbers instead of letters unless the sequence has several sub‐levels.  
Always use round bullets instead of square bullets. If several levels of bullets are necessary, the first level 
should use a black bullet with the second level using a clear bullet. If subsequent levels of bullets are required 
change the shape to square and begin with a black bullet followed by a clear bullet.  
Do not use coloured bullets, for example – red, blue, green or yellow. Using coloured bullets tends to wash out 
the bullet when using a black / white printer.  
Always have at least two bulleted statements together. Do not use bullets to highlight a single reference. The 
same principle holds true for numbered statements.  

7 | Page   INTERNAL USE ONLY   Document Style Guide 


 

 
Notes / Caution / Important References  
Notes, Caution statements, and important references should be highlighted to capture the attention of the 
reader. The following formats should be used when calling out this type of content. 
 

              Note:   

    (Field colour = 219/236/204) 

  Caution! 

    (Field colour = 248/247/215) 

  Important! 

    (Field colour = 219/241/255) 
  
A carriage return should be used to separate this information from the next sentence in the document. 
Sentences preceding the highlighted text should have 12 point spacing between the last sentence and the 
Note, Caution statement, or important reference.  
 
Other Considerations  
Do not use carriage returns between paragraphs. The paragraph spacing recommendations in this document 
replaces the need for carriage returns. Reducing carriage returns in a document helps maintain a smaller 
overall document size which is important in documents containing graphs, flow diagrams, tables, etc.  
The logo should be displayed using the size depicted in the header and cover page of this Style Guide.  

8 | Page   INTERNAL USE ONLY   Document Style Guide 

You might also like