Dokumentation Projekte

[aqe89]

Hallo

Da ich mich langsam aber sicher an kleinere Projekte wage kann.Habe ich mal darüber nachgedacht.
und was alles zu einem Projekt gehört, ich bin dann auf Dokumentation und Technische Unterlagen gestossen.

Jetzt meine Fragen:
1)Was für Dokumentationen macht ihr bei Mini(bis 3 Daten),kleinen(um die 10 Daten),mittleren(um die 20-30 Daten) oder grossen(alles über 30 Datensätze) Projekten?

2)Hat jemand Beispiele von einer Dokumentation die er mir geben könnte, von eher kleineren Projekten?

3)Ich vorhin mal ein Brainstorming über Projekt Ideen gemacht. Und ich habe ein paar Ideen weiterverfolgt. darunter war auch eine einfache Verschlüsselungssoftware, mit einem eigenen simplen Algorithmus.
Wie dokumentiert man einen Algorithmus, so das er gut verständlich ist?


grues aqe89

[Xin]

1)Was für Dokumentationen macht ihr bei Mini(bis 3 Daten),kleinen(um die 10 Daten),mittleren(um die 20-30 Daten) oder grossen(alles über 30 Datensätze) Projekten?

Mini: keine
Klein: Kommentare, Gliederungen
Mittel: Sauberer Codeaufbau, Gliederungen, Kommentare, eventuell ein ReadMe, eventuell Klassendokumentation
Groß: Sauberer Codeaufbau, Gliederungen, Klassendokumentation, eventuell Planungen, eventuell UML-Diagramme, Handbuch

2)Hat jemand Beispiele von einer Dokumentation die er mir geben könnte, von eher kleineren Projekten?

Code: Alles auswählen

/* What happends here?
 *
 *  Something mysterious is going on...
 */

3)Ich vorhin mal ein Brainstorming über Projekt Ideen gemacht. Und ich habe ein paar Ideen weiterverfolgt. darunter war auch eine einfache Verschlüsselungssoftware, mit einem eigenen simplen Algorithmus.
Wie dokumentiert man einen Algorithmus, so das er gut verständlich ist?

In dem man in ihn sauber implementiert und den Code in kleinen Blöcken kommentiert, sowie in der Klassendokumentation die Funktionsweise des Algorithmus beschreibt.

Peferkter Code liest sich im Idealfall wie seine eigene Dokumentation und spiegelt optisch ein Diagram mit dem Aufbau des Algorithmus wieder.

Zur Klassendokumentation verwende ich Doxygen.

[aqe89]

danke dir.

ich muss eben jetzt eine Dokumentation über ein Konstruktionsprojekt machen. Es werden wahrscheinlich mehr als 40 Seiten, ohne den Anhang.

Klassendokumentation

oh, gibts in C klassen?
Werde eh bald auf C++ umsteigen.

[Xin]

danke dir.

ich muss eben jetzt eine Dokumentation über ein Konstruktionsprojekt machen. Es werden wahrscheinlich mehr als 40 Seiten, ohne den Anhang.

Klassendokumentation

oh, gibts in C klassen?

Sicher.
Nur hilft Dir C nicht dabei sie zu deklarieren. ^^

Werde eh bald auf C++ umsteigen.

Guter Plan.