Benutzerhandbuch

From ADempiere
Revision as of 04:31, 22 January 2008 by Nwessel (Talk)

Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.

Ziel: Erstellung eines Benutzerhandbuchs für ADempiere
aber nicht nur "ein" Handbuch. Wir wollen die Möglichkeit schaffen, unterschiedliche Handbücher, z.B. für Administratoren, Integratoren, Endanwender, etc. zu erzeugen. Außerdem wollen wir gemeinsam auch an der Dokumentation arbeiten.

Arbeitspaketverantwortlichkeit:Norbert Wessel (Georg Schütz)

Mitglieder:Georg Schütz

   * metas 
   * KaMUX 
   * Evenos
   * BayCIX
   * Action42 

Vorschlag für Inhaltsverzeichnis

  • Einführung
  • Grundlagen
  • Stammdatenpflege
  • Prozesse
    • Verkauf
    • Einkauf
    • Materialwirtschaft

Vorschlag für Technik

  • Werkzeug TeX/LaTeX
  • Dateiablage in einem Repository
  • Screenshots als .png
  • Alternativ wurde noch DocBook genannt
  • Alternativ könnte DITA als Dokumentationsstandard mit entsprechenden Tools genutzt werden.

Dokumentieren mit LaTeX oder DITA hat viele Vorteile:

  • Verteiltes Schreiben, weil nicht in WYSIWY(P)G (What you see is what you probably get) sondern in "What you write is what you mean" gearbeitet wird. Einzelne Kapitel oder Abschnitte können in separate Text-Dateien verpackt werden
  • Nummerierungen, Referenzen und Verzeichnisse werden automatisch richtig aufgelöst
  • Es können nahezu beliebige Ausgabeformate erzeugt werden. Vom .pdf über html bis hin zur Steuerung von Druckmaschinen ist fast alles möglich
  • Für alle Plattformen (insbesondere Linux, Mac und Windows) verfügbar

DITA bietet darüber hinaus:

  • Cross-Media Publikation
  • Themenorientiertes Single-Sourcing (LaTeX ist dagegen dokumentenorientiert)
  • XML-basiert, daher unmittelbar nahezu überall verwendbar