Child pages
  • Technische Dokumentationen im Intranet
Skip to end of metadata
Go to start of metadata

Viele Unternehmen schreiben ihre Softwaredokumentationen gleichzeitig mit Codes und mit der Hilfe von XML oder anderen Publishing-Tools, damit die Entwicklung der Dokumentationen mit der Softwareentwicklung übereinstimmt. Aber die Projektdokumente, speziell Diagramme, werden des öfteren immer noch in Dateien geschrieben, auf lokalen Computern gespeicherten, und dann per E-Mail, an Leute die damit arbeiten müssen, verteilt. Das ist keine gute Zusammenarbeit.

Am besten ist es, wenn man alle technischen Unterlagen an einem Platz hat, wo man sie immer einsehen kann, wo alle Veränderungen zuverlässig rückverfolgbar sind, und wo Autoren zusammenarbeiten und dazu beitragen können.

Confluence für technische Dokumentationen

Technische Dokumentationen sind so wichtig für Atlassian, dass Sie dem Thema "Technische Dokumentationen mit einem auf Confluence basierendem Intranet entwickeln" einen eigenen Bereich gewidmet haben.

Confluence ist ein ideales Tool, für die Entwicklung und Speicherung von Dokumentationen, inklusive:

  1. Alle möglichen Arten von Projektdokumentationen, inklusive Bedarfsanalyse, Spezifikationen, Anwendungsfälle, Designunterlagen, UML Dokumentationen
  2. Technische Anleitungen, Bedienungsanleitungen, Installationsanweisungen, Administrator-/Systemverwaltungs-Dokumentationen
  3. Trainingsunterlagen
  4. Whitepaper und Forschungsarbeiten
  5. Patent- und Förderanträge
  6. Und, natürlich, Meeting Agenden, Beschlüsse und Ergebnisse.

Warum Confluence bestens für technische Dokumentationen geeignet ist

Confluence unterstützt Wiederverwendung

"Single-Sourcing" ist in der technischen Dokumentationswelt aus gutem Grund populär. Es reduziert Wiederholung und Überflüssigkeit, und erhöht Einheitlichkeit. Zum Beispiel, können Sie dieselben Anleitungen für eine Software-Bedienungsanleitung, Online-Hilfe und Trainingsunterlagen verwenden.

Das geht ganz einfach mit den bereits integrierten Makros "Auszug" und "Auszug einschließen", oder Sie können auch das "Multi Excerpt Macro"-Addon installieren. Confluence Vorlagen und Entwürfe können quer durch alle Bereiche wiederverwendet werden und erzwingen ein einheitliches Format für Ihre Dokumentationen.

Funktionen für Reviewer

Benutzern können verschiedene Funktionen zugewiesen werden, damit sie die, bei technischen Dokumentationen erforderlichen, Überprüfungen vornehmen können: Peer-Reviews, sowie technische und funktionale Überprüfungen. Reviewer können direkt auf den Seiten kommentieren oder auch Inline-Kommentare abgeben.

Vollständige Dokumentenhistorie

Es ist genauso wichtig, Veränderungen in Dokumenten zu verfolgen, wie beim codieren. Confluence bietet eine vollständige Änderungshistorie an, so dass man ganz einfach auf vorherige Versionen zurückgreifen kann.

Verschiedene Formate veröffentlichen

Confluence bietet integrierte Optionen, zur Veröffentlichung von Seiten und Bereichen, in HMTL, XLM und PDF, an. Mit der Hilfe von Addons, kann man exportierte PDF und Word Dateien verbessern, und als DocBook XML, EPub, Eclipse Help und JavaHelp exportieren.

Dokumenten-Lebenszkyklus-Verwaltung

Confluence hat den Lebenszyklus von Dokumenten, angefangen bei gesperrten Entwürfen, über eingeschränkte Review-Zugriffe, bis hin zu Veröffentlichungen, abgedeckt. Mit der Hilfe von Addons, kann man alte Dokumente automatisch kennzeichnen und einem Reviewer zuteilen, als obsolet markieren, oder direkt archivieren. Alles gemäß einem von Ihnen erstellten Zeitplan. Andere Addons erweitern integrierte Arbeitsabläufe, Veröffentlichungen und Versionsmanagementkapazitäten.

Diagramme sind ein wesentlicher Bestandteil von technischen Dokumentationen

Diagramme sind eine großer Bestandteil von technischen und projektspezifischen Dokumentationen, werden aber immer wieder getrennt entwickelt und auf lokalen Rechnern versteckt.

Mit draw.io für Confluence, können Sie Diagramme gemeinschaftlich und direkt in Confluence erstellen und jeden Schritt nachverfolgen. draw.io ist die optimale Auswahl für visuelle Darstellungen von Prozessen, Infrastruktur, Konzepten und für das Dokumentieren von Code-Strukturen, Verknüpfungen und Arbeitsabläufen.

Mehr über draw.io erfahren?

 

 


 

Intranet Anforderungen:

Technische Dokumentationen

 

 

See this page in English.

  • No labels