Scribd
Upload
2 views

Documentation

The document outlines the components of technical and user documentation for a system. Technical documentation includes a data dictionary, annotated code, validation rules, calculations, flowcharts, installation guides, testing results, and security settings. User documentation serves as a guide for users, detailing software/hardware requirements, instructions with visuals, and troubleshooting support, emphasizing the importance of both types for system maintenance and user understanding.

Uploaded by

Jerome k-Jerome
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
2 views

Documentation

The document outlines the components of technical and user documentation for a system. Technical documentation includes a data dictionary, annotated code, validation rules, calculations, flowcharts, installation guides, testing results, and security settings. User documentation serves as a guide for users, detailing software/hardware requirements, instructions with visuals, and troubleshooting support, emphasizing the importance of both types for system maintenance and user understanding.

Uploaded by

Jerome k-Jerome
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

Technical documentation

Technical documentation is an overview of the structure of the


system, how it was put together, and how it works.
It will include:
● A data dictionary to show how data has been structured
within the system
● Any programming code or macros will be annotated to
explain their purpose and anything unusual
● Validation rules will be listed with the criteria used for
successful input and the error messages that they
generate
● Explanation about how certain calculations work
● Flowcharts to show how different parts of the system
work and other diagrams that may have been used
during design and development such as ERDs and
DFDs
● Installation guide for the installation team and also in
case the system has to be installed again in the future
● All results of testing will be recorded
● All security settings will be documented to show who has
authority to certain parts of the system

User documentation
User documentation is a user guide giving instructions to the
user on how to use the system which can be either electronic or
printed.
● an introduction to the purpose of the user guide should be
included
● all the software and hardware requirements will be listed
● instructions must be written along with screenshots and
diagrams
● bullets/numbering points
● troubleshooting section in order to guide the usr through
email

Importance of documentation (both types)


Technical documentation is needed so that anybody carrying
out future maintenance of the system has a guide on how the
system was developed and how it works.

User documentation is needed so that the user can learn how


to use the new system or look up how certain features work.
The troubleshooting section will also be of importance.

You might also like