Documentation Standards
Documentation Standards
Record of Revisions
TABLE OF CONTENTS
Rotation: 0
<<Fields in Table>>: Cambria 10 pt, Bold, Top Center aligned (Using Cell Management)
<<Table of Contents>>: Cambria 12 pt, Bold, Center aligned and All Caps
<<TOC 1>>: Cambria 10 pt, Bold, Left aligned and All caps
<<TOC 2>>: Cambria 10 pt, Left aligned and All caps
<<TOC 3>>: Cambria 10 pt, Left aligned, Inclined and All caps
<<Heading 2>>: Style should be Heading 2, Cambria 11 pt, Bold and Left aligned
<<Heading 3>>: Style should be Heading 3, Cambria 11 pt, Bold and Left aligned
1.5 Headers
Set the Header and Footer size in the Page Setup to 0.5”
<<Logo>>: Left top most side with height 0.46” & Width 0.84”
<<Name of the standard>> Cambria 10 pt , Right aligned top most side and All Caps, Bold
1.6 Footers
<<CIL/STD 01>>:
Continuous page numbering should be followed throughout the document, starting with page number 1 at
section 1. Header and Footer will starts from second page of the document
Title page should contain Border with the following properties; (Insert PictureAuto shapesBasic
charts)
Colors and Lines:
Color: Black
Weight: 3 pt
Size:
<<Fields in Table>>: Cambria 10 pt, Bold, Top Center aligned (Using Cell Management)
<<Table of Contents>>: Cambria 12 pt, Bold, Center aligned and All Caps
<<TOC 1>>: Cambria 10 pt, Bold, Left aligned and All caps
<<TOC 2>>: Cambria 10 pt, Left aligned and All caps
<<TOC 3>>: Cambria 10 pt, Left aligned, Inclined and All caps
<<Heading 2>>: Style should be Heading 2, Cambria 11 pt, Bold and Left aligned
<<Heading 3>>: Style should be Heading 3, Cambria 11 pt, Bold and Left aligned
2.5 Headers
Set the Header and Footer size in the Page Setup to 0.5”
<<Logo>>: Left top most side with height 0.46” & Width 0.84”
<<Name of the standard>> Cambria 10 pt , Right aligned top most side and All Caps, Bold
2.6 Footers
<<CIL/GDL 01>>:
Continuous page numbering should be followed throughout the document, starting with page number 1 at
section 1. Header and Footer will starts from second page of the document
Title page should contain Border with the following properties; (Insert PictureAuto shapesBasic
charts)
Colors and Lines:
Color: Black
Weight: 3 pt
Size:
<<Fields in Table>>: Cambria 10 pt, Bold, Top Center aligned (Using Cell Management)
3.3.1 A single lined border shall be provided with the following information
<<Heading 2>>: Style should be Heading 2, Cambria 10 pt, Left aligned and not Bold and not italic
<<Bulleted points - First level>>: Cambria 10 pt, Bulleted as , Indent to be increased for one time and
Justified
<<Bulleted points - Second level>>: Cambria 10 pt, Bulleted as o, Indent to be increased for two times
and Justified
3.4.1 A document may have only sections which are further divided into sub-sections. In this case, each
section (main headings - first level) need not start on a new page.
Any document can have the following levels of information:
Ver.No 1.0 CIL/STD 01 Page 14 of 22
Proprietary and Confidential
DOCUMENTATION STANDARDS
Note: The fourth and fifth levels should be used with discretion as and when necessary within
the first three levels.
3.5 Headers
Set the Header as follows with the size 0.5” in the Page Setup
3.6 Footers
Set the Footer as follows with the size 0.5” in the Page Setup
Continuous page numbering should be followed throughout the document, starting with page number 1 at
section 1. Header and Footer will starts from second page of the document
Color: Black
Weight: 3 pt
Size:
The <<Doc No: XX/<<Prj Code>>: Cambria 14 pt, bold, Right aligned
<<Project Name>>: Cambria 14 pt, Bold, Centered and Title case capitals
<<Name Of The Template>>: Cambria 14 pt, Bold, Centered and Title case capitals
<<Fields in Table>>: Cambria 10 pt, Bold, Top Center aligned (Using Cell Management)
<<TOC 1>>: Font Style is TOC1; Cambria 10 pt, Bold, Left aligned, All Caps, Numbering is as 1.0; 2.0; 3.0
etc.,
<<TOC 2>>: Font Style is TOC2; Cambria 10 pt, Left aligned, All Caps, Numbering is as 1.1; 2.1; 3.1 etc.,
<<TOC 3>>: Font Style is TOC3; Cambria 10 pt, Left aligned, All Caps, Numbering is follows as 1.1.1;
2.1.1; 3.1.1 etc.,
<<Heading 2>>: Style should be Heading 2, Cambria 12 pt, Bold and Left aligned and All Caps
<<Heading 3>>: Style should be Heading 3, Cambria 11 pt, Bold and Left aligned and All Caps
<<Heading 4>>: Style should be Heading 4, Cambria 10 pt, Bold and Left aligned and All Caps
<<Bulleted points - First level>>: Cambria 10 pt, Bulleted, Indent to increased for one time and
Justified
<<Bulleted points - Second level>>: Cambria 10 pt, Bulleted, Indent to increased for two times and
Justified
4.4.1 A document may have only sections which are further divided into sub-sections. In this case, each
section (main headings - first level) need not start on a new page.
Note: The fourth and fifth levels should be used with discretion as and when necessary within
the first three levels.
Ver.No 1.0 CIL/STD 01 Page 17 of 22
Proprietary and Confidential
DOCUMENTATION STANDARDS
4.5 References
References should have a serial number followed by the document name.
4.6 Appendix
Appendices should use letters, not numbers.
Example: Appendix A, Appendix B, Appendix C. If there are sections within a particular appendix, they
should be numbered with the letter of the appendix and consecutive numbers, e.g., A1, A2 etc.
4.7 Headers
Set the Header and Footer size in the Page Setup to 0.5”
<<Logo>>: Left top most side with height 0.46” & Width 0.84”
<<Name of Template>> Cambria 10 pt , Right aligned top most side and Uppercase, Bold
And Header should be Bottom Bordered
4.8 Footers
<<T01>>: T for Template, 01 is the standard sequence in the list of standards documents;
Continuous page numbering should be followed throughout the document, starting with page number 1 at
section 1. Header and Footer will starts from second page of the document with page No 2.
Set the Header and Footer size in the page setup to 0.5.
<<Organization logo>> It should be Left aligned (in First Row and First Column) with the following
properties;
Rotation: 0
<<Name of the Form>>: Cambria 10 pt, Bold, Left Align and Title case
This will have items for data entry. These will be in Title case; Cambria 10 pt, Bold and Centered
And the work sheet name should be as <<Name of the form>>_V # with Cambria 10 pt, Bold and Centered
5.1 Headers
<<Logo>>: Left top most side with height 0.46” & Width 0.84”
<<Name of the form>> Cambria 10 pt , Right aligned top most side and Uppercase, Bold
5.2 Footers
Center Section:
Right Section:
6.2 First Table in the check list should contain the following details with Cambria 10 pt, Bold and
Left aligned (Using Cell Management)
Project Code:
Project Name:
Components (s) and Version (s) Reviewed:
Date of Review
Date of Checklist Completion:
Customer:
6.3 Second Table in the check list should contain the following details
6.3.1 <<S.No>>; <<Item>>; <<Yes/No/NA>>; <<Comments>> with Cambria 10 pt, Bold and Centered (Using
Cell Management)
<<Heading>>: It contains a set of Questions related to particular section ex: Data Usage is the section and
related question comes under Data Usage section
It should be in Cambria 10 pt, Bold and Left aligned center (Using Cell Management)
<<Body Text>>
All Serial Numbers should be aligned to Center
<<Questionnaire>>: Cambria 10 pt and It should be aligned to Left aligned center (Using Cell
Management)
<<Yes/No/NA>>: The content which is going to be in this section should be in Cambria 10 pt and
Centered (Using Cell Management)
<<Comments>>: The content which is going to be in this section should be in Cambria 10 pt, Left
aligned center (Using Cell Management)
6.4 Third Table in the check list should contain the following details with Cambria 10 pt; Bold and
Top Left aligned
All fields should be in title case and Date format should be as <<Mmm, dd, yy>>
6.5 Headers
<<Logo>>: Left top most side with height 0.46” & Width 0.84”
<<Name of the Checklist>> Cambria 10 pt , Right aligned top most side and Uppercase, Bold
6.6 Footers
Footer Table width should be 6.8” and the contents in the table are Top Center aligned (Using Cell
Management)
<<CHK01>>: CHK for Checklist, 01 is the alphabetical sequence of the checklist in the list of Checklists;
Continuous page numbering should be followed throughout the document, starting with page number 1 at
section 1. Header and Footer will starts from second page of the document with page No 2.
Page Setup:
Margins:
o Top – 1”
o Bottom – 1”
o Left – 1”
Ver.No 1.0 CIL/STD 01 Page 21 of 22
Proprietary and Confidential
DOCUMENTATION STANDARDS
o Right – 1”
Paper:
o Letter
o Width - 8.5”
o Height – 11”
Lay out:
o Header – 0.5”
o Footer - 0.5”