System documentation

Documents must be

  • Well structured
  • Easy to find
  • Easy to modify (update)

More to be considered

  • Use the language everyone understand
  • Separate functional and technical layer
  • Write / update documentation must be part of a delivery of a development project… don’t postpone it
  • Shoot videos (use screen recorder) to show how the GUI is used for certain tasks
  • Developers should sit with the user to make sure they use the system as expected

results matching ""

    No results matching ""