Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What are the core elements to include in Support Documentation? [closed]

I have created an application which needs 'hand-over' to the support group in the next month.

The application is fairly small (2 months development), and consists of two client side applications and a database, it's written in c# for the windows platform.

I have a broad idea of what to include in a support document, but I haven't needed to make very many support documents so far in my career and I want a solid list of items to include.

I guess my goal is to make the lives of everyone in the support group easier and as stress free as possible.

So I guess my questions are:

  1. What should a support document absolutely contain

  2. What additional things have you put in support documents to make them extra useful.

  3. What other activities can be done before hand-over to make all our lives easier?

like image 277
Matthew Rathbone Avatar asked Oct 15 '08 16:10

Matthew Rathbone


People also ask

What are the elements considered during documentation?

The elements that make up the many kinds of technical documents are often similar in form and function. These elements, collectively called the format, include titles, abstracts, introductions and the like. Writers use formats to establish the order of content in the document's front matter, body, and end matter.

What are the two types of documentation?

Documentation can relate to two different types: products and processes. Product documentation describes the product under development and provides guidelines on how to execute actions with it. Process documentation, on the other hand, relates to all the material created during development.


1 Answers

Having been on both sides of this process professionally, I can say that the following should be mandatory:

  • the documentation of the code (javadoc, doxygen, etc)
  • details on build process
    • where to get current source
    • how to file bugs (they will happen)
    • route to provide patches either to the source or to customers
  • how it works (simple, but often overlooked)
  • user-customizable portions (eg there is a scripting component)
  • primary contacts for each component, aka escalation path
  • encouragement for feedback from Support as to what else they want to see

I'm sure lots of other things can be added, but these are the top priority in my mind.

like image 81
warren Avatar answered Oct 14 '22 07:10

warren