For this discussion, address some of the challenges you face in providing technical documentation for non-technical...

70.2K

Verified Solution

Question

Electrical Engineering

For this discussion, address some of the challenges you face inproviding technical documentation for non-technical users in yourModule 5 User Documentation Project. Respond to the followingquestions:
What file format will you use? Why?
How will users access your guide?
Should your guide be available online? Offline? Both?
What plan do you have to keep your guide updated?
Should you include screenshots? Screencasts?
Would you supplement this guide with in-person training?
What other general concerns do you need to consider in thedesign of your documents?

Answer & Explanation Solved by verified expert

3.9 Ratings (487 Votes)

Template for IDA Project Project Id Template for specific development Contract ID User Requirement Issue 1 TABLE OF CONTENTS 0 PREFACE PLEASE READ FIRST 1 01 Purpose of this document 1 02 Use of this document 1 03 The User Requirements document 2 04 Definitions acronyms and abbreviations 3 05 Related documents 3 1 INTRODUCTION 5 11 Purpose of the document 5 12 Overview 5 13 References 6 14 Definitions acronyms and abbreviations 6 2 GENERAL DESCRIPTION 7 21 Objective 7 22 System concept 7 23 Concept of operations 8 24 Users and user interface 8 25 Operational characteristics 9 26 Control support and maintenance 9 27 System architecture and construction 9 28 Assumptions and dependencies 9 3 SPECIFIC REQUIREMENTS 11 31 General 13 32 User facilities 13 33 System interfaces 14 34 Communications requirements 14 35 Hardware requirements 14 36 Capability requirements 14 37 System management functions 15 38 Other products 15 39 Constraint requirements 15 DOCUMENT CONTROL 18 DOCUMENT SIGNOFF 18 DOCUMENT CHANGE RECORD 18 0 PREFACE PLEASE READ FIRST 01 PURPOSE OF THIS DOCUMENT 1 This document is a generic User Requirement document for use by IDA projects It provides guidance and template material which is intended to assist the relevant management or technical staff whether client or supplier in producing a project specific User Requirement document It is also useful background reading for anyone involved in developing or monitoring the IDA Management System IDA MS 02 USE OF THIS DOCUMENT 1 This Preface is addressed to the users of this generic document and is not meant to be retained in any project specific User Requirement documents based on it 2 The remaining sections numbered 1 2 3 constitute a template that should be used to construct the projectspecific User Requirement document Text in normal case is in the most part boilerplate that can be retained amended or deleted in the document Text in italics provides instructions on how to complete a section and should be removed once the section is written 3 The template should be used pragmatically that is where a section is not relevant it should be omitted Conversely the material contained in this document is not necessarily exhaustive if there is a subject that is relevant to the project but is not included in this document it should still be included 4 This document has been prepared using MS Word 97 The following variables are currently recorded as File Properties under MS Word They may be modified by that means or overwritten directly at each occurrence in the document at the discretion of the user a Summary Properties Title Type of document ie User Requirement Author Authors of document Keywords Document reference ie IDAMSUR b Custom Properties Proj Id Short mnemonic of IDA Project set in this document to Project Id Project Full name of IDA Project set in this document to Template for IDA Project Contr Id Short identifier of contract set in this document to Contract ID Contract Full name of contract set in this document to Template for specific development Version Issue number currently Issue 1 Date Date of document currently 17 January 2001 03 THE USER REQUIREMENT DOCUMENT 1 The function of a User Requirement document is to serve as the mandate or terms of reference for the design development and realisation of the technical component of a system or subsystem within an IDA Project Usually there is only one User Requirement document for each IDA Project even when the required development encompasses more than one development contract 2 A User Requirement document is produced as a result of appropriate Requirements Analysis activity based on the stipulations of the Project Definition document and the Global Implementation Plan All specific requirements in the User Requirement document must be consistent with similar statements in higherlevel specifications if they exist 3 The User Requirement document is the primary input to subsequent System Design work and to the procurement specifications for pertinent system development contracts 4 Requirements Analysis will generally include review of all relevant documents including the Project Definition document and the Global Implementation Plan establishment of an initial system concept if not already done consultation of users consolidation of inputs negotiation of a definitive statement of User Requirements 5 All users both endusers and operatorsmaintainers should be consulted Consultation may be by any expedient means including interviews workshops questionnaires and e mail 6 The user in the title of this document is a deliberately vague term intended to encompass all parties who have a legitimate interest in the system envisaged including even customers who will never see it They are thus sometimes called stakeholders They may include for example those who will actually operate the telematics system envisaged those who will operate or manage the processes which the telematics system will support the external customers of those processes those who will support the system or its users or provide the platforms on which it runs 7 It must be recognised however that users are generally not directly consulted in the course of Requirements Analysis but only through designated representatives Some representatives are more closely linked to the population they represent than others are of course Nor are all designated representatives fully enfranchised within the development process In particular only a limited number have the power to accept or reject the specifications which are produced 8 It is important that the nature of the entire user population the manner in which they were represented during consultation and negotiation and the way in which specification of User Requirements was or will be approved be spelt out as completely as possible in the User Requirement document 9 There may be a conflict of requirements where there are multiple stakeholders and users These must be resolved before this document is finalised 10 The final decision on approval of the specification of User Requirements should be with the pertinent Sectoral Committee Therefore the User Requirement document should not be circulated as other than an unauthorised draft until that approval has been given the User Requirement document should be in all respects presented at a level and in a manner suitable for evaluation and approval by the Sectoral Committee 04 DEFINITIONS ACRONYMS AND ABBREVIATIONS 1 The following is a list of definitions for this template Context See Answer

Get Answers to Unlimited Questions

Join us to gain access to millions of questions and expert answers. Enjoy exclusive benefits tailored just for you!

Membership Benefits:

Unlimited Question Access with detailed Answers
Zin AI - 3 Million Words
10 Dall-E 3 Images
20 Plot Generations
Conversation with Dialogue Memory
No Ads, Ever!
Access to Our Best AI Platform: Flex AI - Your personal assistant for all your inquiries!

Become a Member