Example Product User Guide

Transcription

1 Example Product User Guide

2 Copyright Intended purpose Intended audience Conventions Safety notices Contact address Convention For more information... Copyright 2015 doc-department. All Rights Reserved. This document contains information owned by doc- department and/or its affiliates. Do not copy, store, transmit or disclose to any third party without prior written permission from doc-department. Other product and company names may be trademarks or registered trademarks of other companies, and are the property of their owners. They are used only for explanation, without intent to infringe. This guide provides product and technical managers with an example of some key features of a user guide This Example Product User Guide is intended for product and technical managers interested in improving the quality of their product information. This document uses the following conventions: Description A cross-reference to a related or more detailed topic. [ ] Text enclosed in square brackets indicates optional qualifiers, arguments or data. <> Text enclosed in angle brackets indicates mandatory arguments or data. Indicates a hazardous situation which, if not avoided, could result in death or serious injury. Indicates a hazardous situation which, if not avoided, could result in moderate injury, damage the product, or lead to loss of data. Indicates an important situation which, if not avoided, may seriously impair operations. Additional information relating to the current section. doc-department Suite 23 Bonnington Bond 2 Anderson Place Edinburgh EH6 5NP ID-DOC-MAN ii

3 Contents Contents iii 1 Hardware Description Overview Features Metrics Connections Wiring connections Software overview 6 2 Getting Started Package contents Powering up Initial configuration Configure for remote operation 8 3 Operations Configure the Example Product hardware Check for software updates Restart the hardware 9 4 Software Description Main Menu Weighing an item Change settings 10 5 Hardware Specification Part specifications Environment Regulatory EN standard 11 6 Troubleshooting Scale does not connect to server 13 ID-DOC-MAN iii

4 1 Hardware Description This chapter details the Example Product, its connections, and its weights and dimensions. 1.1 Overview The Example Product scale is an example of a typical product which doc-department might produce documentation for. As a hardware product, it should be supplied with a User Guide and Quick Start Guide. It also has accompanying software, so this should also be detailed in the documentation. Figure Features Example Product scale The Example Product scale has the following features: Fully-integrated touch screen Wifi connectivity Extended battery life Printer (optional) ID-DOC-MAN

5 Example Product - User Guide 1 Hardware Description 1.3 Metrics Width: 23 cm Height: 19.2 cm Weight: 2 kg 1.4 Connections Figure Wiring connections Example Product connector A table listing the wiring connections for the Example Product. The wiring of this connector must be completed by a qualified technician. Table 1 Example Product connections Pin Connection Cable colour 1 TX+ Blue 2 TX- Grey 3 +24V AV Red 4 GND White 5 0V Green 6 GND Blue ID-DOC-MAN

6 Example Product - User Guide 1 Hardware Description 1.6 Software overview Figure 3 Example Product main interface ID-DOC-MAN

7 2 Getting Started The Example Product is designed to be quick to set up and easy to use. 2.1 Package contents Figure 4 Example Product Example Product package contents Item Description 1 Separate weighing cup 2 Weighing cradle 3 Touch-screen Powering up 1. Plug the Power adaptor mains plug into a mains power outlet. 2. Plug the Power adaptor Jack plug into the counter power adaptor port. 3. Press the Power button to power up the Example Product scale. ID-DOC-MAN

8 Example Product - User Guide 2 Getting Started 2.3 Initial configuration Connect the Example Product scale to a server to log weight and counting information. Figure 5 Initial configuration setup Administrator Remote Local System Support 2.4 Configure for remote operation The Example Product scale can be configured to be operated remotely. 1. Initiate software interface 2. Click Operations 3. Select Remote access and provide the following information: Username Password IP connection details ID-DOC-MAN

9 3 Operations This chapter describes common tasks required for the operation of the Example Product. 3.1 Configure the Example Product hardware The Example Product scale can be used either with a separate weighing cup or by placing items directly into the weighing cradle. Insert the weighing cradle into the device: Figure 6 Insert the weighing cradle 3.2 Check for software updates The Example Product automatically checks for software updates each time it connects to the server. 3.3 Restart the hardware To restart the Example Product scale, press and hold the Power button on the front of the device. ID-DOC-MAN

10 4 Software Description This chapter provides a description of the configuration dialogs for the Example Product. 4.1 Main Menu You can do the following from the main menu on the Example Product touch-screen: Enter product details for the item to be weighed Tap to view Previous data Change weight and region settings 4.2 Weighing an item 1. Ensure that the Example Product scale is on a level surface and the output weight reads zero. 2. Enter product details using the touch-screen. You can enter information for the Item name and category. 3. Place the item in the Example Product scale weighing cradle. 4. Wait for the output weight to settle on a number. 5. Tap Save to save the weight reading. The weight information is stored against the Item name in the database. 4.3 Change settings 1. From the Main menu, tap The Settings page is displayed. 2. Tap to change the options on this screen. Weight settings: Metric or Imperial Wifi connectivity Clear data ID-DOC-MAN

11 5 Hardware Specification This chapter details the hardware specifications for the Example Product. 5.1 Part specifications The Example Product scale is made of robust, shatter-proof material. The optional Example Product printer integrates fully into the scale. Additional information can be included in further sub-topics. 5.2 Environment 5.3 Regulatory Internal variant operating temperatures: 0 C (32 F) to +50 C (122 F) Storage temperature: -20 C (-4 F) to + 70 C (158 F) 47 CFR (2011) Part 15 subpart B Class A (US federal code of regulations) This product complies with the European Low Voltage Directive 2006/95/EC and EMC Directive 2004/108/EC EN & 2 Low & High temp EN & 64 Sinusoid & Random vibration EN (1992) IP66 Dust and Water Ingress This product meets the requirements of the EC restriction of hazardous substances (RoHS) directive 2002/95/EC In accordance with the EC Waste Electrical and Electronic Equipment (WEEE) directive 2002/96/EC this product must be sent to a recycling plant for proper disposal at the end of its use EN standard The Comité Européen de Normalisation (CEN) released the EN standard in 2006, when it replaced 28 other European standards. It details the standards and expectations of high-quality professional translators. It has guidelines for the following: ID-DOC-MAN

12 Example Product - User Guide 5 Hardware Specification Project management Encourage complete documentation of every stage of the project. Quality management and review The 'four eyes' principle states that any translation should be looked over at least once by another language expert. Technical resources TSPs should have adequate software for the task. TSP-customer relationship Value-added services Localisation or terminology work. Qualifications of individual translators ID-DOC-MAN

13 6 Troubleshooting This chapter provides troubleshooting information to resolve common issues. 6.1 Scale does not connect to server If the Example Product scale does not successfully connect to the server, it may not be correctly configured. To re-configure the settings, power off the device and power in back on again. ID-DOC-MAN