Die externe Dokumentation richtet sich an die Anwender eines Produktes, welche aber keine heterogene Gruppe ist. Auch der IT-Betrieb eines Unternehmens ist ein Nutzer der externen Dokumentation. Der Fokus ist hier Bereitstellung, Aktualisierung, Datensicherung und alles, was für den Betrieb und die Nutzung des Produktes erforderlich ist. Der Endanwender will mit dem Produkt seine Aufgaben lösen, also eine produktive Leistung erbringen. Das kann die Buchhaltung für ein Unternehmen, eine Personal- oder Fertigungsplanung oder aber auch das Entwickeln einer Steuerung für eine Maschine sein.

Ihre Dokumentation sollte:

Zum Erstellen bieten sich sogenannte spezielle Help Authoring Tools (HAT) an, ebenso können natürlich auch Component Content Management Systeme (CCMS) für Softwaredokumentationen genutzt werden. Es gibt auch einige spezielle Verfahren wie z.B: Documents as Code in der gleichen Systemumgebung, bei dem die Dokumente wie Code verwaltet werden, in der die Entwickler arbeiten.

Help Authoring Tools:

• MadCap Flare
  Erstellt modulare Online Hilfen in verschiedenen Formaten, kann aber auch PDFs und Worddokumente erzeugen. Erfordert erhebliche Einarbeitung.
• Adobe RoboHelp
  Wie MadCap Flare, als Teil der Technical Communication Suite, arbeitet Robohelp auch im Zusammenspiel mit FrameMaker. Erfordert erhebliche Einarbeitung.
• Help+Manual
  Es lassen sich sowohl Onlineformate als auch PDFs generieren. Relative einfache Einarbeitung.
• MadCap Doc-To-Help
  Ergänzt/erweitert MS Word. Die Dokumentation lässt sich übersichtlich modularisieren und in vielen Onlineformaten ausgeben. Relative einfache Einarbeitung.

Softwaredokumentation wird heute kaum noch als gedrucktes Buch übermittelt. Teilweise wird die Dokumentation noch als PDF geliefert, das sich ein Nutzer bei Bedarf ausdrucken kann. Stand der Technik sind HTML-basierte Formate. Hier ein kleiner Überblick:

In letzter Zeit werden für Softwaredokumentation auch vermehrt sogenannte Content Delivery Portale (CDP) eingesetzt. Diese bieten im Bereich von Suchen und Filtern umfangreichere Funktionalitäten als die reinen HTML5 Seiten. Sie ermöglichen darüber hinaus:

• Rollen und Rechtekonzept für die Benutzer.
• Mechanismen, die Inhalte zu aktualisieren.
• Facettierte Suche – man gibt einen Begriff ein, erhält dann die eine Liste von Suchtreffern und eine Liste von Facetten (Sprache, Version, Produktmerkmale etc.), mit denen man die Suche verfeinern kann.

Interne Dokumentation umfasst alle Dokumente, die notwendig sind, um die Software selbst zu entwickeln, zu testen und zu pflegen.

• Fehlt die Dokumentation, entstehen hohe Aufwände, sobald die Software überarbeitet werden muss oder einer der ursprünglichen Entwickler ausfällt. Im schlimmsten Fall kann ein komplettes Produkt scheitern, weil es nicht mehr gepflegt werden kann.
• Die interne Dokumentation wird oft immer weitergeschrieben und entwickelt sich dadurch langsam zu einem Konstrukt, das nicht mehr verstanden wird und wodurch die Benutzerfreundlichkeit leidet.