How to use this wiki - vnphamkt/Project-1 GitHub Wiki

How to use this wiki?

  • Search for problem
  • Find solution for known problems
  • Add details or solutions if found

How to create document?

  1. Problem Problem: Why this document exists. Content: Describe details of what was observed or done
  • What was done, what was the result
  • Error message, key phrases, subject
  • Cause or conditions or symptoms
  1. Solution Purpose: Steps to solving the issue Content:
  • Step by step with image if possible, with cut and paste texts
  • Configuration info, standard vs modified for solution
  • If no solution, what can be done, suggestions on handling issue or customer
  1. Background
  • Purpose: provide deeper understanding to prepare technician for more complex issues
  • Affected Versions, when issue began, related area that can be impacted
  • Reference : what documentation to read, which page and section to find relevant supporting information
  • Known system configuations that works or does not work. Hardware configuration, Operating System, Conflicting products
  • History of the issue if any
  • Date of revision, Name of editor