Hallo Leute! für mein Abschlussprojekt erstelle ich einen Webservice. Dazu gehört Quellcode (Java) und ein paar Konfigurationsfiles(Logging.xml etc.). Der Webservice ist ein Dienst für Server, also nicht für einen menschlichen Benutzer gedacht. Daher habe ich keine Weboberfläche/GUI die ich in einem Benutzerhandbuch beschreiben könnte. Nun dachte ich an ein Technisches Handbuch, welches erklärt wie man die Software erweitert bzw Wartet. Habt ihr Ideen wie so etwas aussehen könnte? gibt es da eventuell sogar Vorlagen an denen man sich Grob orientieren könnte?

Gruß ElBerro und Danke

Soll das die Abschlussdoku werden?

jap IHK Abschlussprojek 2013 Sommer, NRW

Ganz falscher Ansatz. Du sollst eine Projektdokumentation und keine Programmdokumentation schreiben.

Nein ich hab mich wohl falsch ausgedrückt Ich habe bereits Pflichtenheft, Testprotokoll und die Dokumentation ist auch fast fertig. Jedoch machen viele eben als zusätzlichen Anhang ein Benutzerhandbuch. Weil das bei mir nicht geht, würde ich gerne noch ein Technisches Handbuch machen auf das ich dann auch mal verweisen kann. Es gibt wohl Ausschüsse, die sowas gerne sehen.

anhänge sind kein selbstzweck. das heißt, wenn du die doku nur schreibst, damit du eine duko bzw einen anhang hast, dann lass es bleiben. wenn solche eine doku sinnvoll ist, um das programm später einmal zu erweitern, dann solltest du die relevanten teile dokumentieren.

Vielleicht einfach per Javadoc den Klassen entsprechende Kommentare geben.

Bei unserer IHK ist eine System- oder Kundendoku Pflicht und wird mit 10% gewertet. Mach das ruhig. Schaden kann es bestimmt nicht.

Habt ihr Ideen wie so etwas aussehen könnte? gibt es da eventuell sogar Vorlagen an denen man sich Grob orientieren könnte?

Schau dir ein gewöhnliches Benutzerhandbuch an. Wichtig ist, dass du den Kunden führst. Also nicht nach dem Motto: "Hier ist Button A, hier ist Button B". Gleiches gilt bei einer Systemdoku. Erkläre deinen Kollegen nicht was es gibt sondern was es gibt und wie es eingesetzt wird.