Difference between revisions of "Benutzerhandbuch"

From ADempiere
Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.
Line 15: Line 15:
  
 
'''Vorschlag für Technik'''
 
'''Vorschlag für Technik'''
*Werkzeug TeX/LaTeX
 
*Dateiablage in einem Repository
 
*Screenshots als .png
 
  
* Alternativ wurde noch DocBook genannt
+
Anforderung an die Technik: KISS = Keep it simple and stupid
  
* Alternativ könnte [http://dita.xml.org DITA] als Dokumentationsstandard mit entsprechenden Tools genutzt werden.
+
Wunsch: Werkzeug benutzen, dass Leute bereits kennen, um die Hürde fürs Mitmachen so klein wie möglich zu halten
  
Dokumentieren mit LaTeX oder DITA hat viele Vorteile:
+
Vorschlag: bestehendes Wiki nutzen
*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:
+
Vorteile:
*Cross-Media Publikation
+
*einfache Benutzung
*Themenorientiertes Single-Sourcing (LaTeX ist dagegen dokumentenorientiert)
+
*sofort Verfügbar
*XML-basiert, daher unmittelbar nahezu überall verwendbar
+
*Skalierbarkeit: Aus einem MediaWiki lassen sich die Inhalte in ein x-beliebiges Format (wie z.B. Latex) exportieren und später weiter
  
  
  
 
[[Category:Deutsche Lokalisierung]]
 
[[Category:Deutsche Lokalisierung]]

Revision as of 06:54, 7 February 2008

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:

   * metas 
   * KaMUX 
   * Evenos
   * BayCIX
   * Action42 

Benutzerhandbuch Inhaltsverzeichnis


Vorschlag für Technik

Anforderung an die Technik: KISS = Keep it simple and stupid

Wunsch: Werkzeug benutzen, dass Leute bereits kennen, um die Hürde fürs Mitmachen so klein wie möglich zu halten

Vorschlag: bestehendes Wiki nutzen

Vorteile:

  • einfache Benutzung
  • sofort Verfügbar
  • Skalierbarkeit: Aus einem MediaWiki lassen sich die Inhalte in ein x-beliebiges Format (wie z.B. Latex) exportieren und später weiter