what are the different types of documentation?
Documentation is good:
There are two types of documentation.
Product Documentation, and Process Documentation
Process Documentation
Process Documentation refers to documentation created during the Software Development Cycle purely for the use of the developer or maintainers of the software solution. Process Documentation includes data dictionary, initial and final gantt charts, IPO chart, log book, system flowcharts, structure charts, testing documentation, algorithm/flowchart, source code, flow charts context diagrams and data flow diagrams.
Data Dictionary - A data dictionary is a table that holds the identifiers of various variables and constants for use within the system. The use of a data dictionary can help the programmer to see the data types involved and serves as reference during the Implementation process.
Initial/Final Gantt Charts - Gantt charts are used for timing and scheduling events and milestones to be reached within the Software Development Cycle. A gantt chart can be referred to after development to analyse the efficiency of the development process.
IPO Chart - An IPO chart is a chart that allows the programmer to visualise inputs, processes, and outputs of the system.
Log Book/Process Diary - A process diary is something kept by the development team to list and describe actions performed during the development process in a chronological order. The reviewing of this document after development can lead to streamlining of the development process in further projects.
System Flowchart - The system flowchart is an old form of documentation that allows programmers to visualise the entire system, including manual processes and computer processes. As it is old, it contains some outdated forms of computer hardware, including Magnetic Tape.
Structure Charts - A structure chart allows programmers to visualise the interface between modules. It depicts modules of the program, and parameters and flags passed from one another.
Testing Documentation - Testing documentation is needed as all tests must be stated in the documentation for further use and for evaluation purposes. Testing documentation includes test data (both artificially generated and live) used in testing, and the results of testing. It may also include a description of processes such as stress testing, performance testing and security testing. The documents produced when the software is benchmarked is also part of process documentation.
Algorithm/Flowchart - The algorithm and flow chart help to describe the processes of a system. Flowchart is more visual and helps with understanding logic. If you don't know this you will fail the HSC.
Source Code - Code that is in the programming language. Contains comments and intrinsic and internal documentation.
Context Diagrams - Context diagrams are diagrams that are used to further help the programmer visualise the system, and involve External entities (square things), data (lines), and processes (circles).
Data Flow Diagrams - Data Flow Diagrams are similar to Context diagrams but are tested more often in the HSC, and involve Data stores (open ended rectangles)
Product Documentation
Product documentation is documentation given to the user. Product documentation includes things like user manual, online help, help screens, tutorials, screen dumps and troubleshooting guides.
User Manual - States the functions of the program in depth.
Online Help - Balloons and help things that are within the program. Short and succinct.
Help Screens - May take up a whole page or part of the page. On the computer, and can be updated easily.
Tutorials - Guides the user through the common functions of the system.
Screen Dumps - Shows the screen at various stages of the program.
Troubleshooting guides - Helps the user to self diagnose problems with their use of the program.
Question - Explain the different types of errors.
