Introduction - Content Management and Technical …



User Guide TemplateMonth 20YYVersion X.XXCompany InformationCopyright and third-party information as requiredDocument RevisionsDateVersion NumberDocument Changes05/02/20xx0.1Initial DraftTable of Contents TOC \o "1-3" \t "Heading 7,2" 1Introduction PAGEREF _Toc362179665 \h 41.1Scope and Purpose PAGEREF _Toc362179666 \h 41.2Process Overview PAGEREF _Toc362179667 \h 42[Process/WorkFlow 1] PAGEREF _Toc362179668 \h 62.1[Sub-Process or Workflow Step 1] Example: Configure Connect to manage your work PAGEREF _Toc362179669 \h 62.1.1[Procedures for Step 1] Example: To Log in to Connect: PAGEREF _Toc362179670 \h 62.1.2[Procedures for Step 2]: PAGEREF _Toc362179671 \h 72.2[Sub-Process or Workflow Step 2] Example: Asset Record Statuses PAGEREF _Toc362179672 \h 73Appendices PAGEREF _Toc362179673 \h 94Index PAGEREF _Toc362179674 \h 10Introduction Scope and Purpose[Introduce the product and its purpose, highlighting key features and benefits][Introduce the purpose of the user guide, what functionality or workflows will be covered? Are there any assumptions about the users’ knowledge or experience, or prerequisites? ]Process Overview [Provide a concise description of the overall processes managed by the software, and how the user interacts with the system. As applicable, reference related processes and corresponding documentation (you may want to create an ordered list of each workflow/process to be covered).][typical sequence for using the software to manage {group of workflows/functions}:Configure your workspaceManage a key workflowManage another key workflowReportTroubleshoot][You may choose to include a process flow diagram to accompany the text. Consider including subprocess diagrams throughout the guide to introduce new or subsequent workflows][Process/WorkFlow 1][Provide a concise description of the context for this process or workflow, including any requirements or conditions that are relevant. Repeat this entire section for each major workflow or process.]Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam at porta est, et lobortis sem. Duis imperdiet in nisl sed luctus. Vivamus hendrerit molestie urna, eu viverra velit porttitor sit amet. Donec nec ligula vitae elit venenatis tincidunt. Curabitur in est placerat, lobortis ante sit amet, tincidunt tortor. Duis ligula dui, tincidunt ut aliquam quis, gravida in libero. Nunc vel lacinia turpis. Etiam metus neque, ultricies eget odio eu, mollis ultricies lectus. Vestibulum consectetur turpis eget diam dignissim posuere.Proin euismod lectus sed dui accumsan lobortis. Donec iaculis sed magna ac aliquam. Donec sagittis mi at enim gravida, vitae pharetra nunc sollicitudin. Suspendisse mollis turpis in odio lobortis tincidunt. Nullam ut augue eget massa eleifend consequat. Praesent ac vestibulum leo, sit amet tempor urna. Praesent eu quam diam. Morbi tincidunt nec urna at vehicula. Vestibulum tincidunt sit amet urna eget auctor. Nulla faucibus nulla vitae pretium rutrum. Nulla nibh sapien, ultricies eu pellentesque fermentum, molestie et purus..[Sub-Process or Workflow Step 1] Example: Configure Connect to manage your work[Provide a concise description of the context for this sub-process or workflow, including any requirements or conditions that are relevant.]Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam at porta est, et lobortis sem. Duis imperdiet in nisl sed luctus.[Procedures for Step 1] Example: To Log in to Connect:Do plete an action.Select a value.Screen captureScreen captureEnter some text.Drag and drop a value.Click or press something to complete the procedure.[NOTES, CAUTIONS, and WARNINGS provide any relevant or supplemental information about consequences of performing a step incorrectly. Place warnings before the step to be taken. Notes may be placed either before or after the corresponding step.]952502540000NOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam at porta est, et lobortis sem. Duis imperdiet in nisl sed luctus..[Procedures for Step 2]:Do something fairly complex that needs substeps:Do the first thingWhen something happens, do the next thing.Click a button or a link.Enter some plete the plete an action using one of the following options:Option 1Click somewhere.Enter something.Option 2Click somewhere.Enter something.Select a value.Screen captureScreen captureEnter some text.Click or press something to complete the procedure.[Sub-Process or Workflow Step 2] Example: Asset Record Statuses[If a sub-process or workflow step requires additional context and detailed information to properly prepare the user, you can expand a context section to include tables (such as definitions of the values available in a dropdown) or graphics such as flow diagrams. You should add captions to identify tables and graphics, and consider including a table of figures following the TOC if the number of graphics and tables is significant.]Proin euismod lectus sed dui accumsan lobortis. Donec iaculis sed magna ac aliquam. Donec sagittis mi at enim gravida, vitae pharetra nunc sollicitudin. Suspendisse mollis turpis in odio lobortis tincidunt. Nullam ut augue eget massa eleifend consequat. Praesent ac vestibulum leo, sit amet tempor urna. Praesent eu quam diam. Morbi tincidunt nec urna at vehicula. Vestibulum tincidunt sit amet urna eget auctor. Nulla faucibus nulla vitae pretium rutrum. Nulla nibh sapien, ultricies eu pellentesque fermentum, molestie et purus.Indicator DefinitionValue 1Lorem ipsum dolor sit amet, consectetur adipiscing elit.Value 2Sed id neque auctor, pellentesque quam vel, pulvinar lorem.Value 3Morbi in odio vitae dui dictum ultricies eu vel nisi.Phasellus eu dui vitae nisl viverra vulputate ac sit amet turpis.Value 4Vivamus tristique augue ornare lorem lobortis, a pellentesque felis blandit.Value 5Duis at nisi eget ligula fermentum pretium at et felis.Integer consectetur nibh a condimentum rhoncus.Figure X-X: Lorem ipsum dolor sit ametIf you encounter issues not addressed by this user guide, please contact your account manager for additional support.Appendices[Appendices are optional, and are used to provide additional detailed information that may help the end user manage the overall application. Examples could include references to standards (such as W3C standards), technical specifications required for regulatory compliance, checklists, or other information of a technical nature.]Index[Depending on the size or complexity of the final document, consider pulling together an index to assist the using in location specific information. Index entries correspond to tags or categories, and are useful in navigating long books.]Style Sheet InformationThe following styles have been set up in this template. Avoid applying manual character formatting to the document. Applying these styles will assist in the conversion process if the document is to be laid out in a structured authoring tool, content management tool, or an HTML editor.Style NameApply toTitleTitle as listed on the cover page of the documentSubtitleSubtitle as listed on the cover page of the documentHeading 1Chapter Name or Process or WorkflowHeading 2Subsection or SubProcess or Workflow stepHeading 3Subsection 2 or ProcedureCallout Block Copy NoteNotes, cautions or warnings, use arrow graphic on the left marginChapter Body CopyGeneric text following a headingChapter Body Copy – BulletUnordered list within a section or subsection, sometimes within a Step to indicate alternative ways to do something.Chapter Body Copy – Bullet 2A secondary unordered list, within a higher level ordered or unordered listChapter Body Copy – StepAn ordered list (sequential) used in a procedure to indicate the order of actions to be takenChapter Body Copy – Step aA secondary ordered list, e.g. substeps in a procedureChapter Body Copy – IndentSets additional text inward so that it aligns with either Chapter Body Copy – Bullet or Chapter Body Copy – StepChart Body CopyText within a tableChart Header InformationThe first row of a table.CaptionDescriptive text for a table or graphic.HeaderText that appears at the top of each page.FooterText that appears at the bottom of each page.Chart Title and Footer InfoCopyright and other front matter preceding the Table of Contents; additional information used to footnote or provide a legend for a table.TOC HeadingHeading used for Table of Contents, Table of Figures (if applicable), and the Document Revisions pages of the front matter to the document.TOC 1TOC display information for a chapter. Generated automatically from Heading 1.TOC 2TOC display information for a sub-section. Generated automatically from Heading 2.TOC 3TOC display information for a subsection 2. Generated automatically from Heading 3.[Template Instructions]Guidance on building out the user guide. Should be deleted prior to publishing. ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download