Create User Documentation

Slides:



Advertisements
Similar presentations
Requirements gathering
Advertisements

1 Dr. Ashraf El-Farghly SECC. 2 Level 3 focus on the organization - Best practices are gathered across the organization. - Processes are tailored depending.
The Basics of Information Systems
P3, M2,M3,M4.
Human Aspects of System Design Introduction –Designing the human element into a system is paramount to its success –One error incorporated by the human.
Project Scope Management
GSLIS Continuing Education Portfolios for Job-Hunting Laura Saunders Fall 2003.
Maintenance of a system
1 CS 501 Spring 2005 CS 501: Software Engineering Lecture 26 Delivering the System.
Let’s think together 2 What is technical writing? What makes technical writing different from other types of writings? Who writes technical documents?
Documentation 1. User Documentation 2. Technical Documentation 3. Program Documentation.
Basics of Good Documentation Document Control Systems
Systems Life Cycle A summary of what needs to be done.
Tasks 1.Check you have the following posts: 1.Hardware and Software 2.Input and Output 3.Components of a Computer 2.ALL fonts should be a sensible size.
CS102 Introduction to Computer Programming
Introduction to Information System Development.
Computers & Employment By Andrew Attard and Stephen Calleja.
Term 2, 2011 Week 3. CONTENTS The physical design of a network Network diagrams People who develop and support networks Developing a network Supporting.
USER AND TECHNICAL DOCUMENTATION. Computer System Documentation What is documentation?What is documentation? –Communication designed to ease interaction.
1 Shawlands Academy Higher Computing Software Development Unit.
CSI315 Web Applications and Technology Overview of Systems Development (342)
LESSON 8 Booklet Sections: 12 & 13 Systems Analysis.
WORKING EFFECTIVELY IN AN INFORMATION TECHNOLOGY ENVIRONMENT
State of Florida Emergency Support Function 6 1 EMERGENCY SUPPORT FUNCTION 6 - MASS CARE & EMERGENCY ASSISTANCE “Your Role at the State Emergency Operations.
Training & Instructional Design Selecting and Working with Media Lecture a This material (Comp20_Unit4a) was developed by Columbia University, funded by.
Document Control Basics of Good Documentation and
Chapter 14 Information System Development
Making a great Project 2 OCR 1994/2360. User Documentation Your User Documentation is the instructions for how to use the system you have created It is.
CH10: Delivering the System help users to understand and feel comfortable with our product * Training * Documentation TECH Computer Science.
Physical Design of a network People who develop & support networks.
Dobrin / Keller / Weisser : Technical Communication in the Twenty-First Century. © 2008 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
A Brief Overview of Online Help By Jennifer L. Bowie For Electronic Writing & Publishing.
D1.HGE.CL7.01 D1.HGA.CL6.08 Slide 1. Introduction Design, prepare and present reports  Classroom schedule  Trainer contact details  Assessments  Resources:
User Documentation. User documentation  Is needed to help people (the users) understand how to use a computer system or software application, such as.
Teachers Discovering Computers Integrating Technology and Digital Media in the Classroom 5 th Edition Let’s Review Lesson 2! Who Wants to Be a Computer.
Mr Conti 28th March 2014 Lesson Aim To learn about different types of software that are produced for computer systems. Lesson Outcomes Good – will be able.
Intermediate 2 Software Development Process. Software You should already know that any computer system is made up of hardware and software. The term hardware.
1 CS 501 Spring 2002 CS 501: Software Engineering Lecture 24 Delivering the System.
The Software Development Process
CSE 102 Introduction to Computer Engineering What is Computer Engineering?
GCSE ICT Systems Analysis. Systems analysis Systems analysis is the application of analytical processes to the planning, design and implementation of.
Teachers Discovering Computers Integrating Technology and Digital Media in the Classroom 5 th Edition Lesson 6 Technology, Digital Media and Curriculum.
1 CS 501 Spring 2003 CS 501: Software Engineering Lecture 26 Delivering the System.
Session 3 How to Approach the UML Written by Thomas A. Pender Published by Wiley Publishing, Inc. October 5, 2011 Presented by Kang-Pyo Lee.
How Are Computers Programmed? CPS120: Introduction to Computer Science Lecture 5.
1 The Software Development Process ► Systems analysis ► Systems design ► Implementation ► Testing ► Documentation ► Evaluation ► Maintenance.
1 Technical & Business Writing (ENG-715) Muhammad Bilal Bashir UIIT, Rawalpindi.
Dobrin / Weisser / Keller: Technical Communication in the Twenty-First Century. © 2010 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
DOCUMENTATION REF: Essentials of IT (Hamilton et al) Chapter 1.
ICAD3218A Create User Documentation.  Before starting to create any user documentation ask ‘What is the documentation going to be used for?’.  When.
Methods of Training Starter Create your own definition of training. Give an example of training you have undertaken in your life so far. Did you have a.
BE ABLE TO SELECT AND APPLY FAULT REMEDIES TO IT SYSTEMS.
RAMSDENTelecommunications Training RAMSDEN Telecommunications Training RTT75 Create Technical Documentation.
WEB 434 Week 3 Individual Web-Based Supply Chain Paper Individual Web-Based Supply Chain Paper Write a 2-3 page paper, explaining web-based supply chains.
EDU 673 Week 4 Differentiated Instruction for Student Readiness Check this A+ tutorial guideline at
BIS 303 Week 3 DQ 2 What is your organization’s policy regarding the replacement or upgrading of hardware and software? Are there scheduled replacements.
BPA 303 Week 1 Individual Assignment Theories Paper - Resources: University Library - Write a 700- to 1,050-word paper analyzing theories and approaches.
BSA 385 Week 3 Individual Assignment Frequent Shopper Program Part 2 Check this A+ tutorial guideline at
The Professional Technical Communicator
Chapter 2 Introduction to Computer User Support
Software Engineering Summarized Slides.
USER AND TECHNICAL DOCUMENTATION
Writing Software Documentation
BTEC Level 3 Subsidiary Diploma in ICT
Comp 20 - Training & Instructional Design
The Basics of Information Systems
Feasibility Report.
The Basics of Information Systems
Presentation transcript:

Create User Documentation Lesson 2

Definition: User Documentation is the collection of documents that are designed to help people who need to manage, operate or maintain computer hardware or software.

Describe the steps to shut down your computer…. 2 main purposes: Convincing users they need to shut down properly. Telling them how to do it.

Divided into 2 Categories: User documentation: Designed for the end user of the computer hardware or software. May not be a computer specialist Examples of user documentation are manuals, on-line help, wizards and on-line tutorials.

Technical documentation: This is designed for the people responsible for producing or maintaining the hardware or software. When you buy a new computer, you generally get a certain amount of technical documentation of the hardware, so that you (or a technician you employ) know what upgrades and so on are applicable to your computer.

Brainstorming Activity: List as many types of techdocs as you can……. Now list types of user docs…..

Examples of technical documentation include: Data documentation, flow charts, pseudocode, data flow diagrams, Program documentation, and Hardware documentation.

Types of user documentation include: Instructional material – usually accompanies the computer system, be it hardware or software, and provides information on how to use the system or particular aspects of it. Training material – aims to teach people how to use a computer system, usually a software application. It can be used as a self-study guide or as a resource by a trainer.

Also: Policies or procedures documents – describe organisational rules and guidelines and explain how to do a particular job or jobs. They also help with quality assurance as a check that standard procedures are being followed. Reference documentation - provides neither an instructional nor a training role; it is simply a repository of information. It is used by users who are already trained, to remind them of intricate details that they cannot be expected to remember. Reference documentation will be at the user’s fingertips while the product is being used

Media: Paper documentation (print media) Static on-line documentation Computer documentation is presented in a wide range of forms, from the traditional paper books to various computerised media. These media can generally be divided into three groups: Paper documentation (print media) Static on-line documentation Dynamic on-line documentation Examples of the above types?

Questions…. List at least 4 factors that need to be considered when determining the medium? What kind of needs may users have, which need to be considered? What does ‘appropriateness of the medium to the task’ mean?

For Next week… Bring in the WORST piece of user documentation you can find a PRIZE for the Best Bad Document!!