Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Documentation

1,137 views

Published on

A presentation that explains the two types of documentation in software: user and technical documentation

Published in: Education, Technology, Business
  • Be the first to comment

  • Be the first to like this

Documentation

  1. 1. Documentation
  2. 2. Documentation and diagrams <ul><ul><li>Documentation is information to help people use or adapt a system. </li></ul></ul><ul><ul><li>It consists of notes, manuals, diagrams and/or instructions. </li></ul></ul><ul><ul><li>Technical documentation explains how a system or program works. </li></ul></ul><ul><ul><li>User documentation explains how to install and use software. </li></ul></ul>
  3. 3. <ul><ul><li>Diagrams are used a great deal </li></ul></ul><ul><ul><li>in documenting information </li></ul></ul><ul><ul><li>systems. </li></ul></ul><ul><ul><li>A flowchart is a diagram showing the operation of a process. It consists of: </li></ul></ul><ul><ul><ul><li>symbols (or boxes) to represent the operations with messages explaining the operation; </li></ul></ul></ul><ul><ul><ul><li>lines connecting the symbols. These lines may have arrows on them. </li></ul></ul></ul>
  4. 4. System flowcharts <ul><ul><li>A system flowchart represents </li></ul></ul><ul><ul><li>operations on data in an information </li></ul></ul><ul><ul><li>processing system. </li></ul></ul><ul><ul><li>A program flowchart represents the sequence of operations in a program. </li></ul></ul><ul><ul><li>The system flowchart and program flowchart are quite different from one another </li></ul></ul><ul><ul><li>the arrows in a system flowchart represent the flow of data; </li></ul></ul><ul><ul><li>the arrows in a program flowchart represent the order of instructions. </li></ul></ul>
  5. 5. Symbols <ul><ul><li>System flow charts use standard symbols like: </li></ul></ul><ul><ul><li>general symbols for input/output and storage. </li></ul></ul>
  6. 6. Types of documentation <ul><ul><li>There are two main types of documentation </li></ul></ul><ul><ul><li>User documentation is for the company or individual to show them how the system works. </li></ul></ul><ul><ul><li>Technical documentation is for the analysts to update or maintain the system. </li></ul></ul>
  7. 7. User documentation <ul><ul><li>User documentation with software may include: </li></ul></ul>
  8. 8. Technical documentation <ul><li>Technical documentation of a program usually includes: </li></ul><ul><li>System flowcharts </li></ul><ul><li>details of limitations </li></ul><ul><li>Known bugs </li></ul><ul><li>Purpose of the system </li></ul><ul><li>Screen layouts </li></ul><ul><li>a program listing notes </li></ul><ul><li>details of data structures used </li></ul><ul><li>a set of test data and expected results </li></ul><ul><li>Hardware requirements/information Software requirements </li></ul>

×