You are on page 1of 8

REVISION HISTORY

S. Version / Date of Revised Sections Remarks
No. Revision no. release
1 1.0 25-04-98 1st release

.......4 User Manual.......7 ANNEXURE 4 ....................STANDARDS FOR CANOBUREAU MANUAL... ................................................ OCX DOCUMENT VIEWER ...............7 ..0 Header not to be changed 02-01 Table of Contents INTRODUCTION....................................................................................................................3 Abbreviations......4 Reference Manual....................................................... .............................. CENTRAL IMAGE MANUAL AND NEWGEN OFFICE ADDONS...................................................................................................................... .........3 Definitions.....................3 Definitions..........................3 References........................................3 Acronym....6 ANNEXURE 3 ............................................................................3 STANDARD/GUIDELINE....Rev No.................................................................................................................................................................................................................................................3 Purpose.............................................................................................................5 ANNEXURE –1 ............................................... NSMS.......... Acronyms and Abbreviations...................................................................................................................STANDARDS FOR USER MANUAL AND REFERENCE MANUAL..........................5 ANNEXURE –2 STANDARDS FOR NEWGEN GOLD REPORTS.......STANDARDS FOR NEWGEN OFFICE............................. ............... 1....................................................................................................................................................................3 Scope.................

Rev No.0 Header not to be changed 02-01 INTRODUCTION Purpose This document provides the user a set of standards to be followed during the process of writing a user and reference manual. namely. reviewing the contents. understanding the product for which the manual is to be written. Definitions. collecting the material. 1. indentations etc. Scope This document describes the matter related to the content formatting in terms of page setup. Acronyms and Abbreviations Definitions Manual preparation cycle The time lag is from the initiation of the manual writing to its despatch to the customer. It maintains all the guidelines applicable for the user and reference manual prepared for the in-house projects. keying in the contents along with the addition of bitmaps. The cycle includes a series of phases. fixing up the changes. These are pertinent to the guidelines developed in the making of user and reference manual for the concerned software projects. delivering the copies to the customer and maintaining versions for future updations. Acronym Not Applicable Abbreviations Not Applicable References Not Applicable . layout. capturing bitmaps. compiling the material and organizing it. fonts.

Otherwise. These tasks will explain all the various ways of carrying out the operations. It is assorted in the alphabetical order and appears as a part of the Appendix section of the manual.Rev No. All the screens should be placed uniformly with the size of 75% (height and width) which would be aligned centrally in the document. the user enters the chapter number-page number along with the title of the manual or the title of the chapter. In the footer. Prior to the installation. This will be followed by the Copyright document. the standalone setup is briefed. 2. 6. make use of the screens. which details on welcoming the user to the system. make a chapter on Index. Define the footer in all the chapters for the odd and even pages. type and the Company address. the installation would cover both the client and network setup. assort the other chapters task-wise and key in the contents. 1. 10. 11. Arrange the relevant topics of the software chapter-wise. first make the cover page comprising of the manual title. Introduce the user to the system with the first chapter on Introduction. Chapters will cover all the tasks related to the software. 8. To make the manual user-friendly.0 Header not to be changed 02-01 STANDARD/GUIDELINE General guidelines for preparing the user and reference manual are explained below. the recommended hardware and software requirements for the product are covered. 7. 4. To begin with the manual. which would list down all the topics along with their page numbers to be referred to in the manual. This will also describe the essential features of the software. Design the table of contents displaying the topics covered chapter-wise along with their respective page numbers. 9. The next chapter will primarily talk on the installation of the software. Glossary is optional which can furnish the relative description of all the technical words used in the chapters. 3. Compose a document. 5. Similar to the first two chapters. The standard table of contents will display only three levels of headings. User Manual 1. Installation will be explained depending upon the kind of setup the software supports. If the software can be run both on client and network platforms. At the end of the manual. Make use of the user-defined format Table for the table of contents. .

14. 10. 5. which would list down all the topics along with their page numbers to be referred to in the manual. 8. Introduce the user to the system with the first chapter on Introduction. CENTRAL IMAGE MANUAL AND NEWGEN OFFICE ADDONS The font name and size for the Normal Style . Prepare a list of the hardware devices with which the software is compatible and cannot function without it. 7. Grey 3 pts Heading 2 -Arial. Bold.Rev No. Underlined. OCX DOCUMENT VIEWER . Design the table of contents displaying the topics covered chapter-wise along with their respective page numbers. The standard table of contents will display only three levels of headings. first make the cover page comprising of the manual title. the user enters the chapter number-page number along with the title of the manual or the title of the chapter. 2. make a chapter on Index. which details on welcoming the user to the system. All the screens should be placed uniformly with the size of 75% (height and width) which would be aligned centrally in the document.STANDARDS FOR NEWGEN OFFICE. 6. Compose a document. Bold . 3. 12. 11. 4. 1. Error messages that appear in the software are also included in the other section of the Appendix. Define the footer in all the chapters for the odd and even pages. Arrange the relevant topics of the software chapter-wise. At the end of the manual. This will also describe the essential features of the software. assort the other chapters menu-wise and key in the contents. To make the manual user-friendly. 18. All the technical words are assorted in the alphabetical order.Arial. 11. Heading 1 . This will again be a part of the Appendix. NSMS. Make use of the user-defined format Table for the table of contents. To begin with the manual. This will be followed by the Copyright document.Times New Roman. make use of the screens. Chapters will cover all the functionalities related to the software. In the footer. ANNEXURE –1 . Similar to the first chapter.0 Header not to be changed 02-01 Reference Manual 1. 9. These functionalities will be explained through the menu options. type and the Company address. Glossary is then formed as a part of the Appendix section to furnish the relative description of all the technical words used in the chapters of the manual. which in turn will familiarize the user with the basic operations.

25`` • Left –1.48`` • Right–1. with lines above and below the text. Footer -Arial.06 Layout Start with Odd Page Different Odd and Even Pages.25`` • Bottom–1. 9.75`` . 1. 11. Different First Page. Italics Paper Size -Custom Size – 7. 9. 18. Bold.0 Header not to be changed 02-01 Heading 3 -Arial.0`` Outside –0. Grey 3 pts Heading 2 -Arial. 9. 10 Description –Times New Roman. ANNEXURE –2 STANDARDS FOR NEWGEN GOLD REPORTS The font name and size for the Normal – Times New Roman. 9. 12 Heading 1 . 12. Bold Notes -Book Antiqua. Italics Paper Size -Letter – 8 ½`` * 11`` Margins: • Top –2. 14.06`` • Footer –1. 12.25`` • Mirror Images: Inside –1.75`` • Header –0`` • Footer –0.Arial. Regular. Bold Chapter -Arial.78`` • Header –2. Underlined. Footer -Arial. Bold Notes -Arial Narrow. Bold Heading 3 -Arial. with lines above and below the text.5`` * 9`` Margins: • Left – 0. Bold Description -Times New Roman.Rev No. 12.75`` • Right – 1.

14. 12. Bold Heading 3 -Arial. Bold. 9.0” • Bottom 1. Bold Note: Note as a word.STANDARDS FOR CANOBUREAU MANUAL The font name and size for the Chapter -Arial.Times New Roman.0” • Right 1. Title Case Description (Times New Roman. 12. Different First Page. 12 Paper size – Letter-8 ½`` * 11`` Margins .5” * 11”) Margins: • Top 1. Grey 3 pts Heading 2 -Arial. Paper Size (Letter –8. 11. Bold.0 Header not to be changed 02-01 Layout Start with Odd Page Different Odd and Even Pages.25” • Header 0. 12. Normal Contents -Book. Underlined . ANNEXURE 3 .5” • Footer 0. 1. Bold. ANNEXURE 4 . 11 Heading 1 -Arial 20. 12.Rev No.STANDARDS FOR USER MANUAL AND REFERENCE MANUAL The font name and size used are: - Heading 1-Arial. Bold. Title Case Heading 3-Arial. All Caps Heading 2-Arial.5” Layout Start with Odd Page Different Odd and Even Pages. Bold Heading 4 -Normal. Different First Page. with lines above and below the text. 11 Normal -Book Antiqua. Bold) Normal . Antiqua. Bold.

0 Header not to be changed 02-01 • Top – 1`` • Bottom – 1`` • Left – 1.25`` • Header – 0. . Different First Page.5`` Layout Start with Odd Page.Rev No.5`` • Footer – 0. 1.25`` • Right – 1.