Documentation

//__Technical documentation __//
The purpose of any system is basically to make any job/calculations easier and make manual work faster. Systems are usually made for reducing human error and increasing work efficiency by doing letting the software used to make calculations instead of the user to manually work out the numbers. Program listing and coding is used to fix any bugs found later on and they can be found in the program coding. Program language used is basically the language the program is made in and what language the program can ‘understand’ A program algorithm is a logical way of showing commands that the program follows this is usually shown as pseudo code and a flow chart Input formats are the format you are allowed to enter data into the program. Hardware requirements are basically the computer systems hardware needs or in simple words its basically what hardware the system needs Software requirements are the software’s that the system needs to function properly. These are the lowest the lowest memory your system can work on Known bugs are basically the flaws that were found in the system The list of variables are used for showing the things that make the system more flexible This is basically how the program responds to data and how the processed data should look like Output formats are the formats that the system presents the processed data Validation rules are the rules that the system enforces to collect certain data The meaning of the error messages is that something has gone wrong somewhere in the system
 * **Purpose of the system **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Program listing and coding **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Programming language used **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Algorithm (pseudo code and flowchart’s) **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Input formats **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Hardware requirements **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Software requirements **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Minimum software requirements **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Known bugs **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">List of variables **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Sample runs **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Output formats **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Validation rules **
 * **<span style="font-family: 'Bell MT','serif'; font-size: 16px;">Meaning of error messages **

**__User documentation__**
 * ====__Purpose of the system/ program / software package –__ the purpose of the system should be outlined and what the system should be able to do.====
 * ====__How to log in/ out-__ This should contain information on how to login and out of the system and what data is needed to login example : username and password.====
 * ====__How to load /run the software-__ This should help the user use the software properly.====
 * ====__How to save the files__- should contain documentation that should explain how to save files after a person has exited the program or while using the program====
 * ====__How to do a search__ – This should help the user to find out data/files easily.====
 * ====__How to sort data-__ This should tell them how would they save the data/files in specific places====
 * ====__How to do printouts-__ This should let the user to print out their records====
 * ====__How to add, delete or amend records-__====
 * ====__Screen layouts (inputs)-__ This will show data on what inout devices are needed in order to operare the system e.g. qwerty keyboard.====
 * ====__Print layouts (outputs__ this should show how the printed receipt and show and what it should contain e.g. header and footer.====
 * ====__Hardware requirements-__ This should tell the user what requirements do they need to run/improve the hardware====
 * ====__Software requirements-__ This should tell the user what requirements do they need to run/improve the software====
 * ====__Sample runs ( with test data and results)-__ Sample runs test how the system will take diffrent types of data and make verification and validation checks.====
 * ====__Error handling/ meaning of errors-__ This should tell the user what is wrong with their software or====
 * ====__Troubleshooting guide / help lines/FAQs-__ This should help the user to understand more about the software.====
 * ====__Tutorials-__ This could help the new user, in which they are guided through each step of accomplishing particular tasks.====