Gelöst Dokumenationserstellung: Vorgehensweise

[Thomas Lisson]

Hallo zusammen,

ersteinmal ein großes Dankeschönan alle, die sich die Zeit nehmen und Mühe machen, an der Doku mitzuwirken.

Dieses Forum ist nicht öffentlich einsehbar und soll dem Dokuteam zur Kommunikation dienen.

Eckpunkte der Dokuerstellung:
- eazySales 0.990 wird dokumentiert
- Deadline 28.12.2006
- kein Wiki, sondern eine geschlossene Dokumentation
- Bilder im PNG Format
- Texte im Textformat. Kann auch HTML (bitte ohne Styles), doc, usw. sein. Bitte kein PDF
- Auf Screenshots bitte personenbezogene Daten ausblenden.
- Doku geht 1.1.2007 online. Als HTML und PDF.

Alle, die mitwirken möchten, können sich bei mir melden und ihr "Lieblinsthema" nennen. Dann wird das Thema reserviert. Es werden nicht mehrere Leute das gleiche Thema dokumentieren. Themen findet Ihr hier: http://jtl-software.de/forum/viewtopic.php?t=2190

Wäre gut, wenn sich auch ein paar Leute finden würden, um Korrektur zu lesen. Fertige Abschnitte werden von uns ins HTML Format gebracht und intern hier veröffentlicht.


Gruß
Thomas

 

[Andreas Grambow]

Da ich selber noch nicht produktiv arbeite, kann ich bei der Doku selber nur die "einfachen" Punkte übernehmen. dazu habe ich etwas im anderen Thread geschrieben

Was ich auch machen könnte / würde

- Korrektur lesen
- Wenn Ihr die HTML macht, würde ich mich anbieten die PDF zu machen und auch zu pflegen (zukünftige Änderungen), so das diese aktuell bleibt.
- Was wir evtl. in die Doku mit aufnehmen könnten (sofern Bedarf) wäre eine FAQ, mit den am häufigsten gefragten Punkten aus dem Forum mit einer kurzen knackigen Antwort :wink: An diese würde ich mich machen, den lesen kann ich ja :lol:

PS: Ich würde die PDF dann auch ähnlich einem Handbuch aufbauen und nicht "nur" den PDF-Creator nutzen. Allerdings benötige ich dann die fertigen Dokupunkte, sobald diese korrigiert und als fertig gekennzeichnet sind. Sonst wird das etwas knapp mit 1.1.07 :?

So das wären meine Angebote. Sobald ich mit ES aktiv/produktiv arbeite (2-3 Quartal 2007) kann ich auch gerne weitere Punkte pflegen.

bis dann

 

[Thomas Lisson]

Hallo Andreas,

Dein Angebot klingt sehr gut!

 

[Marcel]

Eckpunkte der Dokuerstellung:
- eazySales 0.990 wird dokumentiert
- Deadline 28.12.2006
...
- Doku geht 1.1.2007 online. Als HTML und PDF.

Hallo zusammen,

mittlerweile sind wir bei Version 0.993 und haben den 02.01.2007.
Und möglichst schnell soll ja nun auch das Bestellwesen kommen...

Frage:
Bleibt es beim Stand der Doku von 0.990 oder wie soll es nun laufen?

Ist eine Doku mit Stand 0.990 ausreichend?
Oder arbeiten wir lieber mit Upgrades für die Doku? Wenn ja, in welchen Zeitabständen soll die Doku aktualisiert werden? Bei jedem Programm-Update? Bei jedem zweiten, dritten oder fünften Update?

Gruß
Marcel

 

[Torsten]

Wie ist denn allgemein der Stand der Doku?
Fehlen noch Teile oder muss noch korrekturgelesen werden?
Wann ist mit der ersten Fassung der neuen Doku zu rechnen?

 

[Thomas Lisson]

Hallo,

Bleibt es beim Stand der Doku von 0.990 oder wie soll es nun laufen?

Es ist nicht viel hinzugekommen. Zahlungsabgleich und ein paar Kleinigkeiten. Von daher bleibts vorerst bei der 0990.

Wenn ja, in welchen Zeitabständen soll die Doku aktualisiert werden? Bei jedem Programm-Update? Bei jedem zweiten, dritten oder fünften Update?

Optimal wäre laufend. Das schaffen wir jedoch wohl nicht.

Fehlen noch Teile oder muss noch korrekturgelesen werden?

Ja, es fehlen noch 2 Teile. Sobald alles beisammen ist, wird's verpackt.

 

[Marcel]

Ich hatte mich mit Andreas abgesprochen, daß ich die endgültige PDF-Datei erstelle, mich um das Layout, Inhaltsverzeichnis usw. kümmere.

Korrektur in Bezug auf Rechtschreibfehler usw. mache ich ohnehin vor der endgültigen Erstellung. Ihr müsst euch also nicht mit Tippfehlern und nem fehlenden Komma aufhalten :wink:

Die einzelnen Kapitel sollten aber am besten inhaltlich schon vorher von Thomas u. Janusch Korrektur gelesen werden. :wink:

Daher aber meine Frage, ob die Doku denn nun den Stand von 0.990 haben soll (wie ursprünglich vorgesehen) oder ob es anders sein soll....

Wenn inhaltlich keine Fragen mehr sind und die Abschnitte von JTL "abgesegnet" wurden, kann der ganze Kram zu mir und ich dreh ihn dann durch die große Mühle :wink:

 

[Thomas Lisson]

Super! Danke für das Angebot. Andread hat mich schon darauf hingewiesen.

Es fehlen noch 2 Teile - nicht allzu große.

 

[Marcel]

@Thomas:
In diesem Zusammenhang möchte ich nochmal an meine PN bzgl. der rechtlichen Seite für die Doku erinnern...sollten wir vielleicht im internen Board besprechen?

 

[Andreas Grambow]

Wenn ja, in welchen Zeitabständen soll die Doku aktualisiert werden? Bei jedem Programm-Update? Bei jedem zweiten, dritten oder fünften Update?

Optimal wäre laufend. Das schaffen wir jedoch wohl nicht.

die Aktuallisierungen könnten Freiwillige weiterhin machen. Dann wäre das Ganze ja auch lösbar. Im Regelfall sind die Änderungen ja nicht so massiv. :wink:

meine Empfehlung -> löst da Ganze ählich der Beta-Testgruppe. Für den Start sollten halt die jenigen, welche ja schon an der Doku geschrieben haben dabei sein. wenn einer keine Zeit mehr hat, kann er das sagen und geht aus der Gruppe.

 

[Torsten]

Gibt es eigentlich schon irgendwelche Neuigkeiten bzgl. der Doku? Ab wann wird die voraussichtlich verfügbar sein?

 

[Marcel]

Thomas hat gesagt, daß noch zwei -nicht besonders große- Teile der Doku fehlen. Weiß aber nicht, welche das sind (vermutlich die rot markierten) bzw. wer die bearbeitet.

Wie schon oben geschrieben, sollen die fertigen Teile dann eigentlich auf Inhalt geprüft werden und danach zu mir, damit ich Inhaltsverzeichnis, Layout und PDF usw. mache.

Eine Mail bzgl. Nutzungsrechte hat Thomas von mir auch schon bekommen.
Aber im Moment ist er wohl verschollen....wird wohl viel zu tun haben :wink:

 

[Thomas Lisson]

Es schleppt sich etwas mit der Doku.

Es fehlen noch 2 Teile. Da wir selbst jetzt nicht zum Dokuschreiben kommen, denke ich, dass wir die Doku erst um dem 20. herum freigeben können. Leider etwas verspätung, aber da kann man nicts machen.

 

[Andreas Grambow]

was fehlt denn noch?

 

[Thomas Lisson]

Kap 4, 6.4-6.8 und 16

 

[Thomas Lisson]

Kap 4 ist fertig. Erstellt von ddcom24.

 

[Torsten]

Fehlen eigentlich noch irgendwelche Abschnitte oder sind mittlerweile alle Teile eingetroffen?

 

[Marcel]

Bei mir ist noch nix eingetroffen :wink:
Fehlt wohl noch irgendwas...

 

[Thomas Lisson]

Hallo

Kap 6.4-6.8 und 16 fehlen, dann kanns losgehen.

 

[shopboy]

Hallo Alle zusammen!

Melde mich hiermit weider zurück unter den Lebenden.
Hatte kurz vor Weihnachten eine Autounfall und bin jetzt seit einiger Zeit wieder Zuhause.

Hatte mit Thomas schon einmal Kontakt und ich erkläte Ihm das ich mich noch schonen muß. Diese Zeit ist jetzt auch vor bei!! Ich liefere euch bis Donnserstagabend die Teile 6.4 bis 6.8 definitiv.

Gruß Ingo

PS. werde mich jetzt auch wieder öfter im Forum sehen lassen.