Sonstiges > Offtopic

Pump Tutorial

(1/2) > >>

Michael84:
Liebe Notes Commnunity,
ich hab die Aufgabe bekommen für eines unserer Firmen Programme die wir Vertreiben eine Art User Guide zu schreiben. Irgendwie steh ich seit Tagen auf dem Schlauch. Ich bin noch sehr neu auf dem Gebiet Lotus Notes und auch bei der Firma wo ich arbeite ,bin ich erst seit ein paar Wochen.
Vielleicht habt ihr eine Idee wie ich meine Doku etwas schönes bzw übersichtlicher Gliedern könnte. Mein Problem ist folgendes....unser Programm ist eine Pump zur Datenintegration. Somit gibt es im Programm sehr viele Felder die Ausgefüllt werden müssen.
Ich hab die Doku in 2 Teile gegliedert.
Teil 1 Felder Erklärung,das sieht recht gut aus und damit bin ich auch zufrieden
Teil 2 Beispiel Übungen für verschiedene Datenintegrationen.Hier herrscht noch das totale Chaos. Wie schon gesagt es gibt so viel Felder und Einstellmöglichkeiten.
Ich würd das so gerne Übersichtlich Gliedern und  Beschreiben. Doch ich komm einfach zu keinen zufriedenstellendem Ergebnis.
Habt ihr eventuell eine Idee?? Für jeden Ratschlag bin ich euch dankbar...!!

Im Anhang mal meine Doku (PDFi) ,momentan stimmen die Grafiken nicht und es gibt auch sicher einigeviele Rechtschreibfehler :)

Gandhi:
Wenn ich was zum Gliedern habe, benutze ich den Mind Manager. Das ist dafür ein unglaublich geniales Tool. Kostet zwar Geld - das ist es aber mehrfach wert.

Ist das eine NotesPump (aka Vorgänger von LEI)?

Dann würde ich erst die Funktion erklären und irgendwann in einem Appendix die Masken auseinandernehmen.
Immer vom Grossen zum Kleinen arbeiten.
Also:
Was macht die Notespump (verbindet wen mit wem)
Wie installiere ich einen Job (Datenquellen, Datensenken, Aktivitätsdokumente)
Wo und wie und vor allem warum wird sie im Unternehmen eingesetzt
Appendix: Technische Details zu den einzelnen Masken, Glossar, ...

Michael84:
Hallo Gandhi
danke für deine Antwort.
Also mein Problem bezieht sich momentan nur so auf die Beispiele für die einzelnen Datenintegrationen.

Das gesamte Tutorial hab ich schon mehr oder weniger Sinnvoll gegliedert *gg
Bei den Beispielen dachte ich mir vielleicht Tabellen zu machen.
1. Spalte Feldname 2. Was hier eingetragen werden sollte

Was ist den das für ein Programm ?? Hast du zufällig auch einen Preis im Kopf?

Unsere Pump läuft zwar auf Notes aber Sie kann einfach alles *gg (fast alles ) Meist können ja nur Integrationen von Notes -> ASCII vorgenommen werden(als beispiel ) wir können mehrere gleichzeitig Integrieren aus verschiedenen Datenbanken und zusätzlich per Formelsprache Aktionen beeinflussen oder ändern. Und alles zur selben Zeit *gg
Naja wie gesagt bin noch ganz neu in diesem Bereich und hab auch noch nie wirklich so eine große Anleitung (trotz technischer Redakteur erfahrung) geschrieben.


Grüße Michael

flaite:
Große Listen von einzelnen Feldern lese ich mir nie durch. Ich bemühe mich z.B. auch immer die Erklärungen von erklärungsbedürftigen Masken in die Masken selbst zu schreiben.

Bzgl. Entwicklungs/Integrationstools sind für mich immer konkrete Anwendungsfälle mit vielen Screenshots am hilfreichsten. Das versuche ich für meine Kunden auch so zu machen. Bilder sind wichtig. Z.B. hantiere ich relativ viel mit MS-Visio rum.
Hier ist z.B. ein gelungenes Beispiel:
http://www.eclipse.org/webtools/community/tutorials/SchoolSchedule/BuildingAScheduleWebApp.html

Du kannst das ja so machen:
Stell dir einen Typen vor, der von dem Tool keine Ahnung hat und ansonsten nicht so auf rumrätseln steht.
Mache für den eine von Anfang bis Ende Beschreibung einer Sache, die man mit dem Tool machen kann. Beschreibe so mehrere Aufgaben, für die man das Tool einsetzen kann.
1. 1 zu 1 Mapping auf eine Tabelle einer relationale Datenbank.
2. Mapping auf mehrere Tabellen einer relationale Datenbank mit einer Struktur von Notesdokumenten
3. Mapping auf ein Textfile
4. Mapping auf ein excel file
5. Mapping auf ein xml File.

Immer schön mit Screenshots und von Anfang bis Ende.

zb wie hier:
http://www.eclipse.org/webtools/community/tutorials/SchoolSchedule/BuildingAScheduleWebApp.html

Axel

TMC:
Beim 1. "Durch-Scrollen" durch die PDF-Datei fällt auf: Man sieht nicht wo man sich befindet.

Wichtig ist erstmal eine Gliederung.
1. ....
1.1 ....
1.2 ....
2. ....
2.1....
2.2....

Als Leser erkenne ich dann: aha, bin im Kapitel 2.3.3 2.2.3 (Einstellungen), das gehört zu Kapitel 2.2 (ASCII Connector).

Am Anfang ein Inhaltsverzeichnis. In Word kannst Du das automatisch erzeugen lassen: Die Überschriften über Formatvorlagen, dann erzeugt sich die Gliederung automatisch.

Evtl. ein Kapitel "Schnelleinstieg" / "Überblick" oder so ähnliches.

Dann noch ein Index, auch das kann Word fast automatisch, musst nur noch an die jew. Stelle klicken, Alt+Shift+X, dann Schlagwort eingeben.
Am Ende der Word-Datei dann den Index erstellen lassen.

Ein Beispiel, damit Du siehst was ich meine: Agenten in Notes/Domino


Wenn ich was in Word schreibe, dann gliedere ich von Anfang an. Man kann das auch schnell umwerfen (z.B. Änderung von 2.2 auf 2.2.1, 2.2.2 etc.).
Aber damit arbeite ich von Anfang an strukturiert.

Wenn ich noch gar nichts habe, skizziere ich grob ein Inhaltsverzeichnis, und erweitere es dann nach und nach. Meistens sieht die Gliederung zum Schluß eh anders aus wie man gestartet hat, eine anfängliche Grobstrukturierung ist aber trotzdem sehr hilfreich.
Mind Maps, wie von Ghandi erwähnt, können da durchaus hilfreich sein. Ich kenne aber einige Leute, die damit nicht gerne hantieren.
Hilfreich ist auch, in Word für die Kapitelebenen (1. erste Ebene, 1.1. zweite Ebene, 1.1.1 dritte Ebene) Shortcuts zu vergeben. Gibt es glaub ich auch schon per Default bis 3 oder 4 Ebenen (Alt +1, Alt+2, Alt+3...).

Navigation

[0] Themen-Index

[#] Nächste Seite