Externe Projekte → SAVE → Checklisten Shareware Qualität

Checkliste Dokumentation

• Über diese Checkliste
  • Zweck
    Die Checkliste zeigt auf, welche Dokumentationen zu einem Shareware Produkt gehören und welche Informationen diese enthalten sollen.
  • Aufbau
    Die Checkliste gliedert sich in die verschiedenen Dokumente, die zu einer kompletten Dokumentation gehören. Einige dieser Dokumente sollen zum Lieferumfang gehören, andere z.B. über die Homepage verfügbar sein.
• Allgemeines
  • Verfügbarkeit
    Teile der Dokumentation, z.B. Readme Dateien etc. sollten auch ohne Installation des Produkts verfügbar sein. Z.B. durch Publikation auf der Website, durch Anzeige vor der Installation oder auch durch Verwendung von ZIP kompatiblen Installationsarchiven.
  • Konsistenz
    Die Konsistenz der dokumentierten Daten ist sicher zu stellen. Die verschiedenen Dokumente dürfen z.B. nicht unterschiedliche Versionsnummern enthalten. Die Onlinehilfe muss bei Änderungen am Produkt angepasst werden.
• Installationsanleitung
  • Systemanforderungen
    Spezielle Systemanforderungen, Betriebssystemversionen, benötigter Plattenplatz, benötigte Rechte etc. müssen genannt sein. Ist nichts genannt, muss das Produkt auch auf jedem Rechner mit jeder Betriebssystemversion unter jedem Benutzer installierbar sein.
  • Anleitung zur Installation
    Die Schritte zur Installation müssen für den Laien verständlich beschrieben sein.
  • Eine gute und übersichtliche Installationsroutine ist das A und O eines jeden Programmes. Die Ideale Installationsroutine benötigt keinerlei Installationsanleitung, da alle Parameter gesetzt werden. Auf eine Installationsanleitung mit dem Mindestmaß "Wie rufe ich die Installationsroutine auf" ist dennoch empfehlenswert und notwendig.
  • Hinweis auf Deinstallation
    Anleitung zur restlosen Deinstallation des Produkts.
  • Hinweis auf Installationssupport
    Supportadressen angeben
  • Typische Installationsprobleme
    Bekannte Probleme und Lösungsmöglichkeiten beschreiben.
• ReadMe
  • Herstellerangaben
    Komplette Herstellerinfo (Adressen, Support)
  • Produktinformation
    Produktbeschreibungen, Lizenzart (Shareware, Freeware...), Preise, Bestellmöglichkeiten, Zahlungsweisen, Erklärung Shareware, Beschreibung der Einschränkungen Sharewareversion
  • Installation
    siehe oben.
  • Versionsangabe
    Angabe der aktuellen Produktversion mit Releasedatum. Änderungshistorie siehe unten.
  • Webadressen
    Hersteller-URL, Produkt-URL, Download-URL, Support-URL, Bestell-URL
  • Hilfe
    Verweis auf alle anderen Hilfedokumente, z.B. Verwendung der Onlinehilfe.
• file_id.diz
  • Format
    Früher war die Größe eingeschränkt: 10 Zeilen zu 40 Zeichen in ASCII. Heute ist das wohl nicht mehr so wichtig, es gibt nur noch wenige BBS Systeme, die das maschinell auslesen.
  • Inhalt
    Herstellerinfo, Produktinfo - siehe oben. Alle Informationen möglichst vollständig - möglichst kompakt
• PAD Datei
  • Vollständige Informationen
    Möglichst alle Felder der PAD Datei ausfüllen. Insbesondere die Herstellerinfo und die Produktbeschreibungen in verschiedenen Textlängen.
  • Inhalte überprüfen
    Die Daten gewissenhaft überprüfen. Ein Fehler in den Daten multipliziert sich sofort auf viele Websites.
  • Ablageort
    Die PAD Datei wird an einer festen Adresse im Internet hinterlegt. Die Adresse sollte im Leben des Produkts nicht mehr geändert werden. Die Adresse wird in der PAD Datei in das dafür vorgesehene Feld eingetragen. Diese Adresse dient später zur schnellen Anmeldung des Produkt in Archiven mit PAD Unterstützung.
  • Außerdem wird die Datei natürlich immer dem Produkt beigelegt.
  • Sollte die Adresse der PAD-Datei doch mal geändert werden müssen, so sollte die jeweils aktuellste PAD-Datei, in der der jeweils aktuelle Pfad zu der Datei enthalten ist, mindestens für 6 - 12 Monate auch unter der alten Adresse verfügbar sein, sodass automatische Update-Systeme der Softwarearchive die Möglichkeit haben, automatisch auf die neue Adresse umzustellen. Beispiel: Bisher unter home.t-online.de/home/irgendwas/pad.xml, neu unter www.irgendwas.de/pad/pad.xml. Also sollte die PAD-Datei, in der nur der "neue" Pfad drinsteht, zweimal vorhanden sein: Einmal unter der neuen, ein weiteres mal unter der alten Adresse. Übergangsweise für mindestens 6 Monate, eher länger.
  • Aktualisierung
    Die PAD Datei muss IMMER aktuell gehalten werden.
• Versionshistory
  • Information über Änderungen / Neuerungen
    Die Änderungshistorie dokumentiert alle Änderungen, Erweiterungen, Fehlerkorrekturen die am Produkt getätigt werden. Der Anwender kann somit nachvollziehen, welche Neuerungen eine Version mitbringt und welche Fehler in welcher Version gefixt wurden.
• Lizenztext
  • Lizenzbedingungen / AGB
    Die Lizenzbedingungen bzw. AGB für das Produkt sollten schnell abrufbar sein (z.B. Datei licence.txt oder lizenz.txt), auch vor der Installation und natürlich rechtlich wirksam formuliert sein.
• Onlinehilfe
  • Format
    Die Onlinehilfe sollte in einem plattformüblichen Format vorliegen, z.B. unter Windows WinHelp oder HtmlHelp.
  • Inhalt
    Beschreibung aller Programmfunktionen, Tutorials für Einsteiger. Außerdem alle Produkt-, Hersteller-, Installation-, Bestellinformationen etc. wie in der ReadMe.
  • Aufruf
    Aufrufen der Onlinehilfe über Icon in Programmgruppe (Startmenü), Menüeintrag "Hilfe", F1 Taste (kontextsensitive Hilfe -> Hilfe direkt zum betroffenen Dialog oder sogar Dialogelement).
• FAQ
  • Häufig gestellte Fragen
    Antworten auf häufige Fragen in Onlinehilfe und auf der Website.