Documentation, Support and Testing Flashcards
What is internal documentation
code comprehension features and details provided as part of the source code
list 4 features a proper internal documentation includes
appropriate module headers
appropriate comments
useful and meaningful variable names
appropriate code indentation
what is external documentation
separate document that is provided through user supporting documents such as a users guide
what is the advantage of online manuals
can use multimedia features
what is the advantage of printed manuals
can use it without PC or internet connection
What is embedded assistance or integrated user assistance
context-specific and task-specific that doesn’t require the users to ask the right questions to find a suitable answer
example of embedded assistance
when the user hovers over a question mark icon and a small text box appears with the support information
what is Frequently asked questions and answers
listed questions and answers that tend to occur that gives users answers to a common problem they may encounter
what is live chat sessions
real time support that is used in emergencies - live video call
what are online portals / web portals
provides users access to updated FAQs and support pages
what is remote desktop connections
allows a specialized person to connect virtually to the user’s PC from another computer
what is a potential risk with remote desktop connections
technician can have full control over the computer
self instructions / self study
the user learns in their own time until they achieve mastery over their subject
advantage of self study
no tuition fee
the user can freely study whenever/ wherever they want to
disadvantage of self study
lack of guidance or teacher support
final result depends on self-motivation