Was gehört alles in eine Softwaredokumentation?

I

internet

Top Contributor
Hallo,
bisher habe ich nichts brauchbares auf diese Frage gefunden.
Ich habe meine erste Software geschrieben (Anlegen von Vorgängen, Benutzerverwaltung, Personenverwaltung etc.).

Was gehört alles in eine ordentliche Dokumentation?
Bisher habe ich die Anforderungen (Lastenheft) und ein paar Workflows abgebildet.
Sollte ich jede Methode kurz beschreiben was sie macht?
Nähere Infos sieht man ja dann im Code.

- Ein Inhaltsverzeichnis
- Wie man Erweiterungen im Code hinzufügt
-.....

Gibt es irgendwo vllt auch sogar eine Vorlage?
MfG
 
Nach Datum sortieren Nach Zustimmungen sortieren
X

XHelp

Top Contributor
Kommt drauf an für wen die Dokumentation ist.
Da können Theoriehintergründe rein
Da kann auch Benutzer sich von der Software rein (Benutzerhandbuch)
Da können bestimmte Codestellen näher erklärt werden oder du machst alles über UML
Interfaces können beschrieben werden
und und und
Kommt wie gesagt drauf an, wer die Doku lesen wird.
 
Zustimmen 0
Ähnliche Java Themen
  Titel Forum Antworten Datum
I Methoden Wohin gehört getImage()? Java Basics - Anfänger-Themen 1
M Wo gehört ein ButtonListener hin Java Basics - Anfänger-Themen 2
T Was gehört in einen Konstruktor? Java Basics - Anfänger-Themen 12
K Wohin gehört in Eclipse ein jpeg-Bild ? Java Basics - Anfänger-Themen 4
LFB In einer For-Schleife alles in einer Zeile ausgeben Java Basics - Anfänger-Themen 14
KyZarr Was brauche ich alles? Java Basics - Anfänger-Themen 2
M Get Methode alles einzeln? Java Basics - Anfänger-Themen 6
P Alles eine Typfrage Java Basics - Anfänger-Themen 7
B Doppelt Verkettete Liste - Ist alles gut so? Java Basics - Anfänger-Themen 3
I Erste Schritte Resource Bundle - Alles in einem File oder mehrere? => Faktor Performance Java Basics - Anfänger-Themen 2
B Schulprojekt mit Java, was kann man alles programmieren? Java Basics - Anfänger-Themen 5
V Was soll alles in den Konstruktor? Java Basics - Anfänger-Themen 3
K JButton alles zurücksetzen Java Basics - Anfänger-Themen 1
E ExecutorService warten bis alles fertig? Java Basics - Anfänger-Themen 5
J Frage zum Thema ... alles mögliche! Java Basics - Anfänger-Themen 6
Anfänger2011 Wie bricht man alles ab wenn eine Bedingung nicht erfüllt ist? Java Basics - Anfänger-Themen 21
J Kann man auch alles in einer Klasse schreiben? Java Basics - Anfänger-Themen 2
D setAlwaysOnTop(true); toFront(); - bringt alles nichts Java Basics - Anfänger-Themen 5
M MergeSort - Threads in Anwendung bremsen alles! Java Basics - Anfänger-Themen 4
M nach dem Minimieren is alles wech.... Java Basics - Anfänger-Themen 7
-horn- Wann wird alles NaN erzeugt? Java Basics - Anfänger-Themen 22
S Regulärer Ausdruck - alles was keine Zahl ist entfernen Java Basics - Anfänger-Themen 2
G Zufallszahlen die alles einmal vorkommen Java Basics - Anfänger-Themen 15
D Es wird nicht alles angezeigt Java Basics - Anfänger-Themen 4
M Was brauch ich alles für Java Programmieren Java Basics - Anfänger-Themen 14
G Einfügen aus Zwischenablage - alles doppelt? Java Basics - Anfänger-Themen 2
G kann man alles mögliche in Obect kapseln? Java Basics - Anfänger-Themen 2
K Programm tut nicht alles, was es soll Java Basics - Anfänger-Themen 3
P Was brauche ich alles um mit Java loszulegen Java Basics - Anfänger-Themen 24
2 Alles Selektieren in JEditorPane Java Basics - Anfänger-Themen 5
G regulärer Ausdruck alles was zwischen ' ' steht Java Basics - Anfänger-Themen 4
G textfield überdeckt alles Java Basics - Anfänger-Themen 3
I Drucker fragen, ob alles in ordnung Java Basics - Anfänger-Themen 3
V was alles ins Userinterface? Java Basics - Anfänger-Themen 3
D Einmal Runden ohne alles Java Basics - Anfänger-Themen 7
C GregorianCalendar glaubt mir alles wieso! Java Basics - Anfänger-Themen 12
I ImageIO.write(bild, "was gibts da alles", pfad); Java Basics - Anfänger-Themen 6
G Paint Methode löscht alles Java Basics - Anfänger-Themen 4
G Was brauch ich alles Java Basics - Anfänger-Themen 7
M JTextField auf anklickern alles wech? Java Basics - Anfänger-Themen 12
M j2ee: was braucht es alles dazu? Java Basics - Anfänger-Themen 3
R Alles ignorieren ausser Zahlen Java Basics - Anfänger-Themen 21
A Was kann Java alles? Java Basics - Anfänger-Themen 22
Kerstininer Vererbung Hilfe beim lernen von Objektorientierung für eine Klausur Java Basics - Anfänger-Themen 10
K Warum wird hier nur etwas in eine txt Datei geschrieben und nicht in alle drei (InputStream/OutputStream/Reader/Writer) Java Basics - Anfänger-Themen 1
I In unterschiedlichen Applikation Zugriff auf eine gemeinsame Anwendung? Java Basics - Anfänger-Themen 8
D 2 ArrayListen gleich sortieren bzw. eine Liste anhand einer anderen Sortieren Java Basics - Anfänger-Themen 6
T Ich brauche eine Schleife die eine beliebige Zahl so lange durch 10 teilt bis zur Null Java Basics - Anfänger-Themen 5
S Java: Wie sortiere ich eine ArrayList benutzerdefinierter Objekte nach einem bestimmten Attribut? Java Basics - Anfänger-Themen 2
J Eine konzeptionelle Frage zu OOP Java Basics - Anfänger-Themen 3
N Ich kriege ganze zeit die Fehlermeldung "Inhalt der Zwischenablage kann nicht in die ausgewählten Elemente eingefügt werden" hat jemand eine Lösung? Java Basics - Anfänger-Themen 6
M Vergleichen, ob eine Liste länger als andere ist Java Basics - Anfänger-Themen 6
T Methode soll etwas ausrechnen und zurückgeben (klappt nd) hat wer eine Idee? Java Basics - Anfänger-Themen 11
Shadowrunner Variablen Gibt es eine Möglichkeit die Ziffern/Stellen einer Zahl fest zu legen? Java Basics - Anfänger-Themen 3
Kingdako Wie löse ich eine Mathematische Formel mit Arrays und Schleifen? Java Basics - Anfänger-Themen 32
M Datentypen While-Schleife eine Java Methode erstellen Java Basics - Anfänger-Themen 3
G Wie wartet man bis ein URL eine Antwort zurückgibt? Java Basics - Anfänger-Themen 5
berserkerdq2 Intelij, wie kann ich einstellen, dass die aktuelle Klasse ausgeführt wird, wenn ich aufs Startsymbol drücke, gibts da eine Tastenkombination? Java Basics - Anfänger-Themen 11
S 2 Reihen ratio-btn, eine Reihe funktioniert andere nicht Java Basics - Anfänger-Themen 4
T Eingabe durch eine Zahl dividieren nachgucken? Java Basics - Anfänger-Themen 4
M mit Maven eine ausführbare Jar bauen Java Basics - Anfänger-Themen 7
P Java Selenium . Parameterized.Parameters erzeugt eine Fehlermeldung Java Basics - Anfänger-Themen 14
J Zugriff auf eine 2. Klasse die per UI-Designer erstellt wurde Java Basics - Anfänger-Themen 1
M Eine Funktion zuweisen Java Basics - Anfänger-Themen 3
J Eine theoretische Frage zur Praxis - JPanel oder Canvas Java Basics - Anfänger-Themen 5
A Methoden Guten Tag , ich wollte so machen dass wenn meine frog an eine fly/bee geht dann an meine Tafel geht der zahl +1 hoch. Java Basics - Anfänger-Themen 2
A Wie führe ich eine Batch-Datei von meiner Java-Anwendung aus? Java Basics - Anfänger-Themen 18
J Beim Start des Programms zB. eine Linie in JPanel ausgeben Java Basics - Anfänger-Themen 4
L Methoden Eine Methode um zu testen ob es ein Nachbar gibt Java Basics - Anfänger-Themen 10
S Eine Idee umsetzen ganz schnell!? Java Basics - Anfänger-Themen 68
I Grundsatzfrage: Belegt eine Referenz auf 'null' RAM, und wenn ja - wieviel ;-) ? Java Basics - Anfänger-Themen 5
jeff98 Wie kann man in Java eine Zeichenformation ausgeben? Java Basics - Anfänger-Themen 9
K loop pausieren für eine bestimmte Anzahl? Java Basics - Anfänger-Themen 1
_user_q Wie eine Methode/Funktion aus einer Klasse mit Constructor aufrufen? Java Basics - Anfänger-Themen 20
Thomas06 Wie kann man mithilfe von boolean herausfinden ob eine zahl durch 5 und 7 teilbart ist ? Java Basics - Anfänger-Themen 7
M Prüfen on eine Zahl im String enthalten ist Java Basics - Anfänger-Themen 3
U jUnit 5 Test für eine addMethode Java Basics - Anfänger-Themen 18
frager2345 Singleton-Muster Java ->Nur eine Instanz einer Klasse erzeugen können Java Basics - Anfänger-Themen 45
A Eclipse IDE - Wie bekomme ich eine ältere Version Java Basics - Anfänger-Themen 6
F Wie kann ich eine Funktion schreiben, die nur in bestimmten Fällen einen Wert zurückgibt? Java Basics - Anfänger-Themen 5
berserkerdq2 Warum muss man manchmal in der RUnmethode sleep in eine schleife tun? Java Basics - Anfänger-Themen 9
berserkerdq2 Findet eine parallele Verarbeitung in Java bei Threads erst statt, wenn man die Methoden auch synchronized? Und wie sieht bei Conditions aus? Java Basics - Anfänger-Themen 8
berserkerdq2 Wozu benötigt man den BiPredicate, kann ich nicht einfach eine normale Methode nutzen, statt BiPredicate? Java Basics - Anfänger-Themen 3
berserkerdq2 Habe eine Klasse, welche public ist, diese hat eine public Methode, die nicht static ist. Wenn ich nun versuche aufzurufen Probleme? Java Basics - Anfänger-Themen 8
berserkerdq2 Zwei Klassen Erben von der Klasse A, die eine Klasse kann ich an Methoden übergeben, die als Parameter A haben, die andere nicht? Java Basics - Anfänger-Themen 3
berserkerdq2 Sende eine Nachricht an den Client und leere den Ausgabestorm, was ist damit genau gemeint? Java Basics - Anfänger-Themen 3
S Eine Variable in einem Array speichern Java Basics - Anfänger-Themen 5
sserio Prüfen, ob eine Zahl eine periodische Zahl ist Java Basics - Anfänger-Themen 20
L Anpassung der Spaltenbreite auch auf eine zweite Tabelle anwenden Java Basics - Anfänger-Themen 8
NadimArazi Wie kann ich eine collision detection für die Paddles in meinem Pong Programm hinzufügen? Java Basics - Anfänger-Themen 4
JordenJost Java ist auch eine Insel für Anfänger Java Basics - Anfänger-Themen 2
berserkerdq2 Warum soll ich shuffle nutzen, um bei Rückgabewert Collection eine Liste zurückzugeben? Java Basics - Anfänger-Themen 3
berserkerdq2 Ich gebe eine ArrayList als List zurück per MEthode, wie kann ich nun aber die ArrayList speichern? Java Basics - Anfänger-Themen 46
berserkerdq2 Überprüfen ob eine Schreibberechtigung auf ein file exisitert bzw. ob man dieses file löschen kann, wie? Java Basics - Anfänger-Themen 9
sserio Java Fx, wie erstellt man einen EventHandler, der durch das Drücken eines Button Texte in eine Table view einfügt Java Basics - Anfänger-Themen 17
M Eine Methode die erkennt ob die ein gegebene zahl größer oder kleiner sein muss Java Basics - Anfänger-Themen 2
Avalon Warum funktioniert eine Bedingung und eine andere nicht? Java Basics - Anfänger-Themen 2
F Suche nach betreuender Person für eine Jahresarbeit der 12. Klasse. Java Basics - Anfänger-Themen 6
X Hilfe beim Übertragen in eine For-Schleife Java Basics - Anfänger-Themen 1
H Eine Methode über Actionlistener beenden Java Basics - Anfänger-Themen 8

Ähnliche Java Themen

Aktuelle Jobs

Neue Themen


Oben