Documentation Stage
There are 2 kinds of Documentation:
- User Documentation
- Technical Documentation
User Documentation
The user documentation is intended to help the users of the
system. The users usually do not really understand about the techniques of the
system. User documentation is provided to give an overview on how to use the
system. There are two forms of User Documentation:
- Paper-Based User Documentation which includes:
-
Table of Contents
-
Introduction
-
Hardware & Software technical details
-
User Guide
-
Vocabulary Terms of the technical terms
-
Simple list to check for the anticipation of
problems (Troubleshoot)
-
Index
- Online Help Files User Documentation
Basically, User Documentation includes:
- List of minimum hardware and software required to use the system
- How to install the system
- How to start / stop the system
- How to use the features of the system
- Screenshots showing the system in typical use
- Example inputs and outputs
- Explanations of any error messages that might be shown
- A troubleshooting guide
Technical Documentation
Technical Documentation is usually used by engineers and
software developers to make changes to the installed system. This kind of
documentation is more complex compared to the User Documentation. The content
of Technical Documentation is:
- Source Codes
- Data Structures
- File Formats used
- Validation Ranges
- Hardware and Software details
- Navigation Layout
- Diagrams and Flowcharts
- Security Details
- How to install the system
- How to restore and backup the system
- Output Formats
- Sample Runs
- etc.
Evaluation Stage
The Evaluation Stage looks at the overall project and
considers how things went. The purpose of an evaluation is to assess the system
to see if it does what it was supposed to do, that it is working well, and that
everyone is happy with it. Evaluation Stage will need:
- A client
- Project Manager
- System Analyst
- Designers
- Developers
- Examiners
- Trainers
- A selection of end-users
Important Points that need to be checked during this stage:
- Efficiency
- Compatibility
- Whether it’s appropriate or not
Some results from the evaluation may require changes to
either hardware or software.
Hardware may need to be updated because:
- Of feedback from end users
- New hardware comes on the market, making change necessary
- There are changes within the company which require new devices to be added or updated.
Software may need to be updated because:
- Of feedback from end users
- Changes to the company structure or how the company works may need
- Modifications to the software
- Changes in legislation may need modifications to the software
The outcome of the evaluation will be to identify any
limitations or problems with the new system.The system analyst will then need
to begin the task of system analysis from the beginning, but this time analyzing
the new system, and then designing, testing and implementing improvements.Thus
the whole process repeats.
Thank you for reading this blog.
References: