What
is aTechnical
Guide?
A
technical Guide Explains how to maintain
you’re system.
Technical Documentation is written for the computer engineers and program designers. These people will maintain the system once it is installed and being used. All systems evolve. This means that the user will need the system to do things better, faster or even in a different way. Some things may have even been overlooked or forgotten. The user may only realise that improvements need to be made once they start using the system.
Maintaining the system means keeping it running well and doing what the user needs it to do.
Technical Documentation is written for the computer engineers and program designers. These people will maintain the system once it is installed and being used. All systems evolve. This means that the user will need the system to do things better, faster or even in a different way. Some things may have even been overlooked or forgotten. The user may only realise that improvements need to be made once they start using the system.
Maintaining the system means keeping it running well and doing what the user needs it to do.
Technical guides can use technical language and system diagrams if they are needed.
A technical Guide will need the following:
Titles,
Explanations of how to upgrade a sub-system e.g. making a better
user interface, adding fields, validation and verification to a database.
The jobs are for the ‘techies’ – the people who design
and make the system better. You may also put in a FAQ section or contact
details (email support address, web site support address, telephone
support line numbers)