Was sind die Kernelemente in Support Dokumentation enthalten? [geschlossen]

Question

Ich habe eine Anwendung erstellt, die 'Hand-over' , um die Support-Gruppe im nächsten Monat benötigt.

Die Anwendung ist ziemlich klein (2 Monate Entwicklung), und besteht aus zwei Client-seitige Anwendungen und eine Datenbank, in c # geschrieben für die Windows-Plattform.

Ich habe eine breite Idee von dem, was in einem Support-Dokument zu schließen, aber ich habe nicht so weit machen sehr viele Support-Dokumente benötigt in meiner Karriere und ich möchte eine solide Liste der Elemente umfassen.

Ich denke, mein Ziel ist das Leben aller in der Support-Gruppe einfacher und so stressfrei wie möglich zu machen.

Also ich denke, meine Fragen sind:

1. Was sollte ein Support-Dokument unbedingt enthalten

2. Welche zusätzlichen Dinge, die Sie in Support-Dokumente setzen, um sie besonders nützlich zu machen.

3. Was andere Aktivitäten kann vor der Übergabe getan werden, um unser Leben einfacher zu machen?

Answer 1

Nachdem professionell auf beiden Seiten dieses Prozesses gewesen, kann ich sagen, dass die folgend sollte sein obligatorisch :

• die Dokumentation des Codes (javadoc, doxygen, etc.)
• Details zu Build-Prozess
  • , wobei die Stromquelle erhalten
  • , wie Fehler in Datei (sie passieren wird)
  • Route Patches, um entweder auf die Quelle oder den Kunden
• , wie es funktioniert (einfach, aber oft übersehen)
• benutzerdefinierbare Abschnitte (zB eine scripting Komponente)
• Primärkontakte für jede Komponente, auch bekannt als Eskalationsweg
• Ermutigung für Feedback von Unterstützung, was sonst wollen sie sehen

Ich bin sicher, dass viele andere Dinge können hinzugefügt werden, aber diese sind die oberste Priorität in meinem Kopf.

Answer 2

1. Functional Specification (Wenn Sie eine haben)
2. Benutzerhandbuch. Erstellen Sie ein, wenn Sie nicht haben
3. Technisches Handbuch, enthaltend
   • Verteilungsdiagramm
   • Softwares Gebraucht
   • Konfiguration und bauen Details
   • Deatils von Server-IP und admin / oracle / websphere Passwörter
4. Test Document
5. Über Ansicht Dokument heraus geben
   • Wenn alle Dokumente gehalten
   • Version Control Repository und sein Projekt / Anwenderinformationen
   • Anwendungsbenutzernamen / Passwort
6. Jede Unterstützung SQL / die Werkzeuge usw. durch das Entwicklungsteam erstellt, für die Analyse, Laden von Daten etc.

Answer 3

1. Neue Screenshots von Operationen und ausgegeben werden.
2. Bevorzugen "einfach online update-fähig" doc (wiki-like) anstelle von Papier oder pdf.
3. Wenn online, machen sie durchsuchbar und vernetzt werden.

Answer 4

• ein Handbuch ist eine saubere Sache (Bilder, Beschreibungen, usw.).
• Ein Überblick über die verschiedenen Funktionen innerhalb der Anwendung

Das ist, was ich ontop von meinem Kopf zu denken, wenn dies „nur“ für Support-Mitarbeiter und nicht die weitere Entwicklung.