Quels sont les principaux éléments à inclure dans la documentation de support? [fermé]

Question

J'ai créé une application qui doit être transférée au groupe de soutien le mois prochain.

L’application est assez petite (développement sur 2 mois) et consiste en deux applications côté client et une base de données. Elle est écrite en c # pour la plate-forme Windows.

J'ai une idée générale de ce qu'il faut inclure dans un document de support, mais je n'ai pas eu besoin de créer beaucoup de documents de support au cours de ma carrière et je souhaite disposer d'une liste complète d'éléments à comprendre.

Je suppose que mon objectif est de simplifier la vie de toutes les personnes du groupe de soutien et de le rendre le moins stressant possible.

Je suppose donc que mes questions sont les suivantes:

1. Que doit absolument contenir un document d'assistance

2. Quels éléments supplémentaires avez-vous mis dans les documents d'assistance pour les rendre plus utiles?

3. Quelles autres activités peuvent être faites avant le transfert des responsabilités pour nous simplifier la vie?

Answer 1

Ayant été des deux côtés de ce processus professionnellement, je peux dire que les éléments suivants devraient être obligatoires :

• la documentation du code (javadoc, doxygen, etc.)
• détails sur le processus de construction
  • où trouver la source actuelle
  • comment classer les bogues (ils vont arriver)
  • route pour fournir des correctifs à la source ou aux clients
• comment ça marche (simple, mais souvent négligé)
• parties personnalisables par l'utilisateur (par exemple, un composant de script)
• contacts principaux pour chaque composant, également appelé chemin d'escalade
• encouragement du support à faire des commentaires sur ce qu’il souhaite voir de plus

Je suis sûr que beaucoup d'autres choses peuvent être ajoutées, mais celles-ci sont la priorité numéro un dans mon esprit.

Answer 2

1. Spécification fonctionnelle (si vous en avez une)
2. Manuel de l'utilisateur. Créez-en un si vous n'avez pas
3. Manuel technique, contenant
   • diagramme de déploiement
   • Logiciels utilisés
   • Détails de la configuration et de la construction
   • Deatils of Server ip et les mots de passe admin / oracle / websphere
4. Document de test
5. Vue d'ensemble du document donnant
   • Où tous les documents sont conservés
   • Référentiel Version Control et détails de son projet / utilisateur
   • Noms d'utilisateur / mot de passe de l'application
6. Tout support SQL / outils, etc. créé par l'équipe de développement, pour analyse, chargement de données, etc.

Answer 3

1. Inclure des captures d'écran des opérations et des résultats.
2. Préférez " mise à jour facilement en ligne " doc (type wiki) au lieu de papier ou pdf.
3. Si vous êtes en ligne, rendez-le consultable et réticulé.

Answer 4

• Un manuel utilisateur est une chose intéressante (images, descriptions, etc.)
• Un récapitulatif des différentes fonctionnalités de l'application

C’est ce que je pense malgré tout si c’est "seulement". pour le personnel de soutien et non pour le développement ultérieur.