Difference between revisions of "Benutzerhandbuch"

From ADempiere
Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.
(Rollen)
 
(23 intermediate revisions by one other user not shown)
Line 1: Line 1:
'''Ziel''': Erstellung eines Benutzerhandbuchs für ADempiere<br>
+
===Ziel===
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)
+
Erstellung eines Benutzerhandbuchs für ADempiere, das sich an Geschäftsprozessen orientiert und als Zielgruppe den Nicht-Techniker adressiert.
  
'''Mitglieder''':
+
===Arbeitspaketverantwortlichkeit===
 +
 
 +
[[User:nwessel|Norbert Wessel]] (Georg Schütz)
 +
 
 +
 
 +
===Vorgehensweise===
 +
*Bereitstellung einer Deutschen AVA in der aktuellen Trunk-Version
 +
*Erstellung eines Inhaltsverzeichnisses: [[User:nwessel|Norbert Wessel]] => [[Benutzerhandbuch:Inhaltsverzeichnis]]
 +
*Entwicklung von Standard-Stilelementen: [[User:nwessel|Norbert Wessel]] => [[Benutzerhandbuch:Hilfe]]
 +
*Erstellung einer Vorlagen-/Beispielseite: [[User:nwessel|Norbert Wessel]] => [[Benutzerhandbuch:Angebot erstellen]]
 +
*Freiwillige Eintragung von Mitgliedern für Kapitel des Inhaltsverzeichnisses mit Namen und Aufwandsschätzung: Jeder
 +
 
 +
===[[Benutzerhandbuch:Inhaltsverzeichnis|Inhaltsverzeichnis]]===
 +
 
 +
 
 +
===Rollen===
 +
*Know-How-Träger, die ADempiere aus der Praxis beschreiben können
 +
*Autoren, die Texte lesbar und verständlich machen
 +
*Tester, die die Ergebnisse in der Anwendung nachvollziehen
 +
 
 +
===Mitglieder===
 
     * metas  
 
     * metas  
 
     * KaMUX  
 
     * KaMUX  
Line 11: Line 30:
 
     * Action42  
 
     * Action42  
  
'''Vorschlag für Inhaltsverzeichnis'''
 
  
*Einführung
+
===Technik===
*Grundlagen
+
 
*Stammdatenpflege
+
Anforderung an die Technik: KISS = Keep it simple and stupid
*Prozesse
+
 
**Verkauf
+
Wunsch: Werkzeug benutzen, dass Leute bereits kennen, um die Hürde fürs Mitmachen so klein wie möglich zu halten
**Einkauf
+
 
**Materialwirtschaft
+
Vorschlag: bestehendes Wiki nutzen
  
'''Vorschlag für Technik'''
+
Vorteile:
*Werkzeug TeX/LaTeX
+
*einfache Benutzung
*Dateiablage in einem Repository
+
*sofort Verfügbar
*Screenshots als .png
+
*Skalierbarkeit: Aus einem MediaWiki lassen sich die Inhalte in ein x-beliebiges Format (wie z.B. Latex) exportieren und später weiter
 +
Nebeneffekt: Die erstellen Inhalte stehen automatisch unter der GNU Free Documentation License 1.2 und sind damit frei verfügbar.
  
* Alternativ wurde noch DocBook genannt
 
  
* Alternativ könnte [http://dita.xml.org 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:
+
[[Category:Deutsche Lokalisierung]]
*Cross-Media Publikation
+
[[Category:Benutzerhandbuch]]
*Themenorientiertes Single-Sourcing (LaTeX ist dagegen dokumentenorientiert)
+
*XML-basiert, daher unmittelbar nahezu überall verwendbar
+

Latest revision as of 07:54, 13 February 2008

Ziel

Erstellung eines Benutzerhandbuchs für ADempiere, das sich an Geschäftsprozessen orientiert und als Zielgruppe den Nicht-Techniker adressiert.

Arbeitspaketverantwortlichkeit

Norbert Wessel (Georg Schütz)


Vorgehensweise

Inhaltsverzeichnis

Rollen

  • Know-How-Träger, die ADempiere aus der Praxis beschreiben können
  • Autoren, die Texte lesbar und verständlich machen
  • Tester, die die Ergebnisse in der Anwendung nachvollziehen

Mitglieder

   * metas 
   * KaMUX 
   * Evenos
   * BayCIX
   * Action42 


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

Nebeneffekt: Die erstellen Inhalte stehen automatisch unter der GNU Free Documentation License 1.2 und sind damit frei verfügbar.