David A. Flynn | Freelancer Portfolio Item #224305

TM Version User Guide Maintenance Instruction Document Version 1.0 David A. Flynn Feb 21, 2012 Copyright Information Copyright © , Inc. 2011 All Rights Reserved This publication is protected by federal copyright law. No part of this publication may be copied or distributed, stored in a retrieval system, or translated into any human or computer language in any form or by any means, electronic, mechanical, magnetic, manual or otherwise, or disclosed to third parties without the express written permission of . makes no representation or warranties with respect to the contents hereof and specifically disclaim any implied warranties of merchantability or fitness for a particular purpose. Further, reserves the right to revise this publication and to make changes from time to time in the contents hereof without obligation of to notify any person or organization of such revision or changes. has prepared this guide for use by personnel and authorized third parties as a guide to proper operation and/or maintenance of equipment and software. The drawings and specifications contained herein are the property of . Trademarked names may appear throughout this document. Rather than list the names and entities that own the trademarks or insert a trademark symbol with each mention of the trademarked name, the names are used only for editorial purposes and to the benefit of the trademark owner with no intention of infringing upon that trademark. Address comments and corrections to: TM Version TMUser Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © Fujitsu America, Inc. 2011. All Rights Reserved External Page | i Revision History Revision History DATE RELEASE REVISION DESCRIPTION MODIFIED BY Feb16, 2012 0.1 Initial draft David A. Flynn Feb22, 2012 1.0 First base lined document David A. Flynn TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © Fujitsu America, Inc. 2011. All Rights Reserved External Page | ii About this Document About this Document This section briefly describes key details of this document – Purpose of this Document The purpose of this document is to assist end users, operators or administrators as authorized by our clients to update the User Manuals of TMandits applications. Scope of this Document The section describes the topics in and out of scope of this document – In Scope The scope of this document includes the description and usage of styles, formats, and best practices implemented in the documentation of manuals of TMandits applications. Out of Scope The scope of this document does not include –  the assistive steps to utilize MS Word to document the user manuals,  the architecture or specifications of TM andits applications, and  the installation process of TM andits applications. Intended Audience of this Document The intended audiences of this document are –  the administrators,  the retailers, and  end users as authorized by our client TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © Fujitsu America, Inc. 2011. All Rights Reserved External Page | iii About this Document Typographical Conventions / Customaries used in this Document The typographical conventions used in this document include the following –  Note: The purpose of this typographical convention is to provide important information corresponding to an already stated fact. This is we depict a note in this document – Note:  Tip: The purpose of this typographical convention is to provide additional information supplementing an already stated fact. This is how we depict a tip in this document – Tip:  Warning: The purpose of this typographical convention is to provide critical information corresponding to an already stated fact. This is how we depict a warning in this document – Warning:  Reference: The purpose of this typographical convention is to refer you to another section in this document or another document or to an external reference. A reference is depicted in the following manner in this document – Reference: For more information on , refer to Section : . TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © Fujitsu America, Inc. 2011. All Rights Reserved External Page | iv About this Document Abbreviations / Acronyms used in this Document The table below describes the abbreviations / acronyms used in this document – ABBREVIATION GUI, UI DESCRIPTION Graphical User Interface, User Interface IPR Intellectual Property Rights RMS Retail Management System TM Trade Mark TOC, TOT, TOF Table of Contents, Table of Tables, Table of Figures Organization of this Document This document contains the four chaptersas indicated below – CHAPTER DESCRIPTION Chapter 1 Introduction Chapter 2 Getting Started Chapter 3 User Administration Module Chapter 4 Retail Module Terms Used in this Document The below table briefly describes the terms utilized in this document – CHAPTER Customer DESCRIPTION An individual or organization that purchases goods and services from the retailer. Item A product that may be sold or returned using the GlobalSTORE POS system. Payment/Tender Monies received from a customer as payment for the POS transaction. Payments / tenders may be made in the form of cash, checks, gift certificates, store credits, debit cards, credit cards, or company-specific A/R charge accounts. Return A GlobalSTORE POS transaction where a customer gives back a purchased item in exchange for the amount the retailer’s return procedure allows. Sale/Transaction A transaction in GlobalSTORE POS in which a customer exchanges an agreed amount for an item. Terminal/Register A workstation where data is entered, automatically recorded or retrieved. User An operator, associate, or any user of the ReturnCENTER system. TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © Fujitsu America, Inc. 2011. All Rights Reserved External Page | v About this Document CHAPTER Velocity DESCRIPTION A ReturnCenter function that enables the retailer to administer & control customer returns with no receipt TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © Fujitsu America, Inc. 2011. All Rights Reserved External Page | vi Table of Contents Table of Contents REVISION HISTORY................................................................................................................................................. II ABOUT THIS DOCUMENT ...................................................................................................................................... III PURPOSE OF THIS DOCUMENT ......................................................................................................................................... III SCOPE OF THIS DOCUMENT ............................................................................................................................................. III In Scope ............................................................................................................................................................... iii Out of Scope ........................................................................................................................................................ iii INTENDED AUDIENCE OF THIS DOCUMENT ......................................................................................................................... III TYPOGRAPHICAL CONVENTIONS / CUSTOMARIES USED IN THIS DOCUMENT .............................................................................. IV ABBREVIATIONS / ACRONYMS USED IN THIS DOCUMENT........................................................................................................ V ORGANIZATION OF THIS DOCUMENT .................................................................................................................................. V TERMS USED IN THIS DOCUMENT ...................................................................................................................................... V TABLE OF CONTENTS.............................................................................................................................................. 7 TABLE OF FIGURES ............................................................................................................................................... 10 CHAPTER - 1. 1.1 OVERVIEW ................................................................................................................................ 11 GRAPHICAL USER INTERFACE (GUI) ELEMENTS AND THEIR REFERENCE PRONOUNS ............. ERROR! BOOKMARK NOT DEFINED. CHAPTER - 2. DEFINED. STRUCTURE OF THE USER DOCUMENTATION SET OF ... ERROR! BOOKMARK NOT CHAPTER - 3. DEFINED. USAGE OF MS WORD AS AN END USER DOCUMENTATION PLATFORM . ERROR! BOOKMARK NOT 3.1 USAGE OF FIELDS ................................................................................................... ERROR! BOOKMARK NOT DEFINED. 3.2 OPENING THE MS WORD SOURCE OF AN FRS UM ...................................................... ERROR! BOOKMARK NOT DEFINED. 3.2.1 Category 1 – Simple MS Word UM Document Source ............................ Error! Bookmark not defined. 3.2.2 Category 2 – Composite MS Word UM Document Source ...................... Error! Bookmark not defined. 3.3 CHANGING THE FIELD VALUES OF FRS UMS ................................................................ ERROR! BOOKMARK NOT DEFINED. CHAPTER - 4. STRUCTURE OF A TYPICAL USER MANUAL .............................. ERROR! BOOKMARK NOT DEFINED. 4.1 COVER SHEET ........................................................................................................ ERROR! BOOKMARK NOT DEFINED. 4.2 COPYRIGHT INFORMATION SECTION ........................................................................... ERROR! BOOKMARK NOT DEFINED. 4.3 REVISION HISTORY SECTION ..................................................................................... ERROR! BOOKMARK NOT DEFINED. 4.4 ABOUT THIS DOCUMENT SECTION .............................................................................. ERROR! BOOKMARK NOT DEFINED. 4.4.1 Purpose of this document Section ........................................................... Error! Bookmark not defined. 4.4.2 Scope of this document Section .............................................................. Error! Bookmark not defined. 4.4.3 Intended Audience Section ...................................................................... Error! Bookmark not defined. 4.4.4 Typographical Conventions / Customaries used in this document section ............ Error! Bookmark not defined. 4.4.5 Abbreviations / Acronyms used in this document section ...................... Error! Bookmark not defined. 4.4.6 Organization of this document section ................................................... Error! Bookmark not defined. TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © 2021. All Rights Reserved External Page | 7 Table of Contents 4.5 AUTO-GENERATED TABLES OF A DOCUMENT SECTION ................................................... ERROR! BOOKMARK NOT DEFINED. 4.5.1 Table of Contents Section ....................................................................... Error! Bookmark not defined. 4.5.2 Table of Figures Section .......................................................................... Error! Bookmark not defined. 4.5.3 Table of Tables Section ........................................................................... Error! Bookmark not defined. 4.6 DOCUMENT HEADER AREA....................................................................................... ERROR! BOOKMARK NOT DEFINED. 4.7 DOCUMENT FOOTER AREA ....................................................................................... ERROR! BOOKMARK NOT DEFINED. 4.8 BODY CONTENT OF THE USER MANUAL ...................................................................... ERROR! BOOKMARK NOT DEFINED. 4.8.1 Introduction to the Suite / Application.................................................... Error! Bookmark not defined. 4.8.2 Getting Started ....................................................................................... Error! Bookmark not defined. 4.8.3 Module Description Sections ................................................................... Error! Bookmark not defined. 4.9 APPENDICES SECTION – FAQS / AUXILIARY INFORMATION / SAMPLES .............................. ERROR! BOOKMARK NOT DEFINED. 4.10 INDEX SECTION ................................................................................................. ERROR! BOOKMARK NOT DEFINED. 4.10.1 Key Points to Note While Generating an Index .................................. Error! Bookmark not defined. 4.10.2 Marking Index Entries ........................................................................ Error! Bookmark not defined. 4.10.3 Generating the Index.......................................................................... Error! Bookmark not defined. CHAPTER - 5. UTILIZED MS WORD STYLES &THEIR COMPOSITION ............... ERROR! BOOKMARK NOT DEFINED. 5.1 COVER SHEET FORMATTING ..................................................................................... ERROR! BOOKMARK NOT DEFINED. 5.2 REVISION HISTORY FORMATTING ............................................................................... ERROR! BOOKMARK NOT DEFINED. 5.3 PREFACE FORMATTING STYLES & THEIR COMPOSITION .................................................. ERROR! BOOKMARK NOT DEFINED. 5.4 BODY CONTENT TEXTFORMATTING............................................................................ ERROR! BOOKMARK NOT DEFINED. 5.5 COMPOSITION OF HEADINGS .................................................................................... ERROR! BOOKMARK NOT DEFINED. 5.6 LISTS AND THEIR FORMATTING COMPOSITION .............................................................. ERROR! BOOKMARK NOT DEFINED. 5.6.1 Unordered List ......................................................................................... Error! Bookmark not defined. 5.6.2 Ordered List ............................................................................................. Error! Bookmark not defined. 5.7 TABLES ................................................................................................................. ERROR! BOOKMARK NOT DEFINED. 5.8 FIGURES ............................................................................................................... ERROR! BOOKMARK NOT DEFINED. 5.9 CROSS REFERENCES & HYPERLINKS ............................................................................ ERROR! BOOKMARK NOT DEFINED. CHAPTER - ADOPTED WRITING STYLE ...................................................... ERROR! BOOKMARK NOT DEFINED. GENERIC POINTS .................................................................................................... ERROR! BOOKMARK NOT DEFINED. SPELLING, GRAMMAR, AND READABILITY STATISTICS ..................................................... ERROR! BOOKMARK NOT DEFINED. WORD USAGE ....................................................................................................... ERROR! BOOKMARK NOT DEFINED. ACTIONS ............................................................................................................... ERROR! BOOKMARK NOT DEFINED. STRUCTURE OF THE MODULE DESCRIPTION SECTIONS.................................................... ERROR! BOOKMARK NOT DEFINED. ILLUSTRATIONS & THEIR PRESENTATION ...................................................................... ERROR! BOOKMARK NOT DEFINED. CHAPTER - 7. CONTENT MANAGEMENT STRATEGY ...................................... ERROR! BOOKMARK NOT DEFINED. 7.1 MASTER DOCUMENT FEATURE OF MS WORD ............................................................. ERROR! BOOKMARK NOT DEFINED. 7.2 DEFECT IDENTIFICATION & REMOVAL PROCESS ............................................................ ERROR! BOOKMARK NOT DEFINED. 7.2.1 Defect Identification ............................................................................... Error! Bookmark not defined. 7.2.2 Defect Removal ....................................................................................... Error! Bookmark not defined. CHAPTER - 8. CONFIGURATION MANAGEMENT STRATEGY ............................................................................ 12 TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © 2021. All Rights Reserved External Page | 8 Table of Contents APPENDIX - A. A.1 ............................................................................................................. 13 SECTION 1 HEADING ......................................................................................................................................13 INDEX .................................................................................................................................................................. 14 TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © 2021. All Rights Reserved External Page | 9 Table of Figures Table of Figures FIGURE 3.2.2: ADVANCED DOCUMENT PROPERTIES DIALOG BOX ................................................... ERROR! BOOKMARK NOT DEFINED. TABLE 1: ELEMENTS OF THE COVER SHEET................................................................................. ERROR! BOOKMARK NOT DEFINED. FIGURE 1: A SAMPLE COVER SHEET........................................................................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 2: INDEX AND TABLES POPUP WINDOW .......................................................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 3: TABLE OF CONTENTS TAB ......................................................................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 4: CONFIRMATION DIALOG BOX TO REPLACE AN EXISTING TOC ........................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 5: INDEX AND TABLES POPUP WINDOW .......................................................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 6: TABLE OF FIGURES TAB ............................................................................................ ERROR! BOOKMARK NOT DEFINED. FIGURE 7: CONFIRMATION DIALOG BOX TO REPLACE AN EXISTING TOF............................................ ERROR! BOOKMARK NOT DEFINED. FIGURE 8: INDEX AND TABLES POPUP WINDOW .......................................................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 9: TABLE OF FIGURES TAB ............................................................................................ ERROR! BOOKMARK NOT DEFINED. FIGURE 10: TABLE OF TABLES TAB ........................................................................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 11: CONFIRMATION DIALOG BOX TO REPLACE AN EXISTING TOF.......................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 12: INDEX AND TABLES POPUP WINDOW ........................................................................ ERROR! BOOKMARK NOT DEFINED. FIGURE 13: MARK INDEX ENTRY POPUP .................................................................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 14: MARK INDEX ENTRY POPUP .................................................................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 15: INDEX AND TABLES POPUP WINDOW ........................................................................ ERROR! BOOKMARK NOT DEFINED. FIGURE 16: CONFIRMATION DIALOG BOX TO REPLACE THE EXISTING INDEX ....................................... ERROR! BOOKMARK NOT DEFINED. TABLE 2: FONTS USED ON THE COVER SHEET WITH THEIR SIZES ..................................................... ERROR! BOOKMARK NOT DEFINED. TABLE 3: PREFACE FORMATTING STYLES & THEIR COMPOSITION..................................................... ERROR! BOOKMARK NOT DEFINED. TABLE 4: COMPOSITION OF HEADINGS ..................................................................................... ERROR! BOOKMARK NOT DEFINED. FIGURE 17: READABILITY STATISTICS OF THIS DOCUMENT ............................................................. ERROR! BOOKMARK NOT DEFINED. TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © 2021. All Rights Reserved External Page | 10 Overview Chapter - 1. OVERVIEW TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © 2021. All Rights Reserved External Page | 11 Configuration Management Strategy Chapter - 2. CONFIGURATION MANAGEMENT STRATEGY A product development environment experiences constant flux with reference to the features and functionalities required by ever changing and dynamic market. In such a scenario, it is important to track changes not only the product suite and its applications but to its accompanying documentation also. This chapter describes the configuration management strategy as implemented in the user documentation of TM. 1. Observe that we have designed each user manual to utilize static text variables, which retain document control information. 2. The purpose of retaining document control information along with the revision history is to map changes or updates to user manuals, which has a direct bearing with the version and build of each application. 3. Whenever you intend to update a user manual, update the document control information, revision history, and document variables first. 4. Then ensure to update all static variables by selecting all content in the document and pressing the F9 key using the keyboard. 5. Ensure to update all auto-generated tables with their page numbers keeping the Show / Hide whitespaces feature switched off. 6. Ensure that the file name of the user manual follows the below file naming convention – - - 7. Increment the revision number by one whenever you perform a review or defect identification exercise. 8. Increment the version number by one whenever you have acceptance of the user manual and you are ready to base line the document. 9. Each time you update the version or revision of a document, ensure to update the document control information, revision history and variables accordingly. 10. Ensure to open the header and footer to update the contained variables as well using the Select All + F9 command. The next section of this document includes an appendix containing screen descriptions of RC. TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © 2021. All Rights Reserved External Page | 12 Configuration Management Strategy Appendix - A. This section describes the visual elements available on the screens of RC. A.1 Section 1 Heading The next section of this document lists an index describing key points of this document. This information navigation aid enables you to quickly lookup required information. TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © 2021. All Rights Reserved External Page | 13 Configuration Management Strategy Index A G Abbreviations / Acronyms used in this Document .... v Abbreviations / Acronyms used in this document section.................................................................22 About this Document................................................ iii About this document section ..................................20 Actions .....................................................................50 Adopted Writing Style .............................................48 Appendices – FAQs / Auxiliary Information / Samples ............................................................................37 Auto-generated Tables of a Document Section .......22 Generating a TOC in MS Word .................................24 Generating a TOF in MS Word .................................27 Generating a TOT in MS Word .................................31 Generating the Index ...............................................41 Generic Points..........................................................48 Getting Started ........................................................35 GUI Elements and their Reference Pronouns ..........10 B Body Content of the User Manual ...........................35 C Category 1 – Simple MS Word UM Document Source ............................................................................13 Category 2 – Composite MS Word UM Document Source .................................................................13 Changing the Field Values of FRS UMs ....................15 Composition of Headings.........................................45 Configuration Management Strategy ......................55 Content Management Strategy ...............................53 Copyright Information Section ................................18 Cover Sheet..............................................................17 Cover Sheet Formatting ...........................................43 Cross References & Hyperlinks ................................47 D Defect Identification ................................................54 Defect Removal .......................................................54 Document Footer Area ............................................34 Document Header Area ...........................................34 F Figures .....................................................................47 I Illustration & their Presentation ..............................52 In Scope .................................................................... iii In Scope section .......................................................20 Index Section ...........................................................38 Intended Audience of this Document ....................... iii Intended Audience Section......................................20 Introduction to the Suite / Application ....................35 K Key Points to Note While Generating a TOC ...........23 Key Points to Note While Generating a TOF ............27 Key Points to Note While Generating a TOT ............30 Key Points to Note While Generating an Index .......38 L Lists ..........................................................................45 M Marking Index Entries ..............................................39 Master Document Feature of MS Word ..................53 Module Description Sections ...................................36 O Opening a Composite MS Word UM Document Source .................................................................14 Opening a Simple MS Word UM Document Source 13 Opening the MS Word Source of an FRS UM ..........13 Ordered List .............................................................46 TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © 2021. All Rights Reserved External Page | 14 Configuration Management Strategy Organization of this Document.................................. v Organization of this document section ...................22 Out of Scope ............................................................. iii Out of Scope section ................................................20 Overview ....................................................................9 P Preface Formatting Styles& their Composition .......44 Purpose of this Document ........................................ iii Purpose of this document section ...........................20 R Revision History Formatting ....................................43 Revision History Section ..........................................19 S Scope of this Document ............................................ iii Scope of this document section ..............................20 Spelling, Grammar, and Readability Statistics .........48 Structure of a Typical User Manual .........................16 Structure of the Module Description Sections ........50 Structure of the User Documentation Set of Fujitsu Retail Suite ..........................................................11 T Table of Contents Section ........................................23 Table of Figures Section ...........................................27 Table of Tables Section ............................................30 Tables .......................................................................46 Terms Used in this Document ................................... v The Defect Identification & Removal Process .........54 Typographical Conventions / Customaries used in this Document...................................................... iv Typographical Conventions / Customaries used in this document section ........................................21 U Unordered List .........................................................45 Usage of Fields .........................................................12 Usage of MS Word as An End User Documentation Platform ..............................................................12 Utilized MS Word styles & their Composition .........43 W Word Usage .............................................................49 TM Version User Guide Maintenance Instruction Document Version 1.0 - UGMID - 1.0 Copyright © 2021. All Rights Reserved External Page | 15