Saturday, March 20, 2010

On user manual and Report

In addition to what Manyazewal has posted, we can add the following points
  1. General Information about the product
  2. Allowed(authorized applications)
  3. Specifications
  4. Usage instruction
  5. Installation Instruction (can include illustrative figures)
  6. Disclaimer
  7. Reference Materials (for technical personel who want to know more about the product)

In our report we can include what issues we considered in writing our user manual, like
  • for what type of users
  • major tasks in installation
  • the method of writing we used (for instance,IF THEN, for troubleshooting during malfunctioning)
  • the number of steps
  • the total estimated time
  • etc

No comments:

Post a Comment