TutorialSchnellvorlage DE
Tutorial-Vorlage
Falls Du eine Idee für ein Tutorial, aber keine Zeit oder Lust hast, dieses vollständig selbst zu schreiben, kannst Du dieses Format verwenden, um dem Dokumentations- und Web-Team all die Informationen zu geben, die erforderlich sind, den Text zu vervollständigen. Die wichtigsten Teile sind hierbei:
- Beschreibung der Technologie, die dargestellt werden soll,
- Zu reproduzierende Schritte
- Anfang und Projekteinrichtung, falls notwendig
- Fertiges Produkt
- Erwartetes Resultat, wenn das Projekt ausgeführt oder deployed wird.
Einführung
Nutze diesen Abschnitt für eine kurze Zusammenfassung der Technologie, die Du vorstellen möchtest. Sinnvollerweise konzentrierst Du Dich hierbei auf die Sicht eines Nutzers, der diese Technologie einsetzen möchte, und fügst einige Beispiele von Anwendungsfällen ein, in denen diese Technologie im täglichen Leben helfen kann. Falls NetBeans einige spezielle Features für den einfachen Umgang mit dieser Technologie bietet, kannst Du hier beschreiben, welche das sind und welchen Nutzen sie bieten.
Zu reproduzierende Schritte
Dies ist einer der wichtigsten Teile. Du mußt die Schritte dabei nicht zu detailliert darstellen. Beispielsweise ist es zum Erstellen eines Projektes nicht erforderlich, "Wähle Datei -> New Project..." aufzulisten. Wir werden diese Schritte im Nachgang einfügen, falls erforderlich. Wichtig sind nur die Schritte, die tatsächlich für Dein Tutorial erforderlich sind, sowie Listings all des Codes, den der Nutzer einfügen soll.
Anfang und Projekteinrichtung
Es ist immer hilfreich, ein vorkonfiguriertes Projekt zur Hand zu haben, welches bereits einige der grundlegenden Code-Beispiele für das Tutorial beinhaltet. Hänge das Projekt als Zip-Paket an die Wiki-Seite für Dein Tutorial an. Denke dabei bitte daran, Dein Projekt vorher aufzuräumen und privaten Code, Konfigurationen, Passwörter etc. zu entfernen, bevor Du die Zip-Datei erzeugst und hochlädst. Falls Du verschiedene, voneinander abhängige Projekte hast, definiere bitte auch den Pfad zu diesen Projekten als relative Verweise in project.properties, nicht in private.properties.
Lösung
Dies ist der wichtigste Teil. Viele Leser werden eventuell nur die fertigen Lösungen öffnen und mit dem Code herumspielen. Viele Menschen werden Deinen Code ansehen - also versuche ihn so aussehen zu lassen, daß Sun dessen stolz sein kann (keine schlechten Programmier-Praktiken, korrekte Javadoc-Kommentare, Kommentare zur Erklärung des Codes etc).
Erwartetes Resultat
Führe hier auf, was der Nutzer sehen sollte, wenn das Projekt ausgeführt oder in einen Anwendungsserver installiert wird. Hilfreich sind auch Ansätze zur Fehlerbehebung, um bekannte und häufig auftauchende Schwierigkeiten zu umgehen.
