Dokumentation

[VPatrick]

Architekturentwurf im Wiki dokumentieren und mit Diagrammen beschreiben.

[Ramunno]

Hi zusammen, ich würde vorschlagen das ich das Klassendiagramm aktualisiere, sobald jeder seine Klasse geschrieben hat. Dazu benötige ich von jedem die Attribute und Methoden, welche die Klasse zur Verfügung stellt. Am besten mit Datentyp, Übergabeparameter und Rückgabewert. Ihr könnt das einfach hier als Kommentar posten.

[KasikciMu]

Restore: Globale Variablen: -FinalTime : string -_Verbose : 0,1 (kommt darauf an wie wir uns entscheiden) Klassenvariablen:

• source : string
• sourcename : string
• destination : string
• usertime : datetime/string
• partial : string

Methoden:

• new()
• addSource(Source : string)
• addDestination(destination : string)
• addSourceName(sourcename : string)
• addUserTime(usertime : string)
• addPartial( partial : string)
• addVerbose( verbose : string/bool)
• restore_r()
• restore_rp()
• string Find_source_r(source : string, sourcename : string, time : string)
• string compare_to(date : string)
• string Find_source_rp(Directory : string, Sourcename : string)
• RestoreDirectory(SourceArchiv : string, Destination : string,SourceName : string)
• DestinationArchiv(Destination : string, SourceName : string)
• RestoreSubDirectory(Source : string, Destination : string, SourceName : string)
• RestoreFile(Source : string, Destination : string)
• string DirectoryUp(Directory : string)
• Verbose()
• DESTROY()

[VPatrick]

Invoker:

• -verbosity : Verbosity (Klassenvariable --> Verbosity-Objekt --> Assoziation zu Verbosity)
• -message : Message (Klassenvariable --> Message-Objekt --> Assoziation zu Message)
• -instances : Instances (Klassenvariable --> Instances-Objekt --> Assoziation zu Instances)
• -level : int
• +setVerboseLevel (level : int)
• +create (arguments : array)
• +slim (arguments : array)
• +restore (arguments : array)
• +partial (arguments : array)
• +del (arguments : array)
• +list (arguments : array)

Verbosity:

• -level : int (Klassenvariable)
• +message : Message (Klassenvariable --> Message-Objekt)
• +setVerboseLevel(level : int)
• +getVerboseLevel() : int
• +verbose(message : string, [state : string])

List:

• -verbosity : Verbosity (Klassenvariable --> Verbosity-Objekt --> Assoziation zu Verbosity)
• -message : Message (Klassenvariable --> Message-Objekt --> Assoziation zu Message)
• -utils : Utils (Klassenvariable --> Utils-Objekt --> Assoziation zu Utils)
• +setVerboseLevel(level : int)
• +list(directory : string)
• +print_list(list : array)

Utils: (von @KasikciMu übernommen um es in eine Hilfsklasse auszulagern)

• -verbosity : Verbosity (Klassenvariable --> Verbosity-Objekt --> Assoziation zu Verbosity)
• +setVerboseLevel(level : int)
• +findLastValidArchive(source : string, timestamp : string)
• +compare_to(date : string)

Message:

• +message(message : string, [state : string])
• +ok([message : string])
• +warning([message : string])
• +error([message : string])
• +colourise(state : string)

Instances:

• +create(level : int) : Create
• +restore(level : int) : Restore

[KasikciMu]

Also bei mir hat sich folgendes verändert:

gelöscht wurde:

• _Verbose
• addVerbose()
• Verbose()

hinzugekommen sind:

• Klassenvariable verbosity : Verbosity-Objekt
• setVerboseLevel(level : int)

[mia8287]

Delete

Klassenvariablen: deleteFile : string mainArchivpath : string archivFullName : string archivName : string verbosity

Methoden: -new(inDeleteFile : string) -init(self : hash) -findPreDir(self : hash) -findLinksPreDir(self : hash, preDir : string) -checkLink(self : hash, allLnkFiles : array) -changeLnks(self : hash, newLnk : string, newDat : string, foundDir : array) -newLink(self : hash, newDat : string, newLinks : hash) -del(self : hash)

[Ramunno]

Könnt ihr mir nochmal die endgültig Fassung eurer Klassen schicken, damit ich das Klassendiagramm für die Präsentation fertigstellen kann. Bitte mit folgenden Punkten:

• Zugriffsrechten: private oder public
• Datentypen
• Übergabeparameter
• Beziehungen zu anderen Klassen: Delegation, Assoziation usw.
• Rückgabe wert

z.B. Attribut: - source: String oder +source:String Methode: - setSource(path:String) oder + getSource():String

Bitte so schnell wie möglich! Danke!

[KasikciMu]

globale Attribute:

• FinalTime: datetime Attribute
• source: String
• sourcename:String
• destination: String
• usertime: datetime
• partial: String
• rel_path: {0,1}
• verbosity: Verbostiy-Objekt

Methode:

• new()
• addSource(Source:String)
• addDestination(Destination:String)
• addSourceName(Sourcename:String)
• addUserTime(Usertime:datetime)
• addPartial(Partial:String)
• setVerboseLevel(level:int)
• restore_r()
• restore_rp()
• Find_source_rp(Directory: String, partial:String)
• RestoreDirectory(SourceArchiv:String)
• DestinationArchiv(Destination:String, SourceName:String)
• RestoreSubDirectory(Source:string, Destination:String)
• RestoreFile(Source:string, Destination:string)
• DirectoryUp(tmp:string)
• DESTROY()

Meine Klasse greift auf die Verbosity-Klasse zu und die Utilis-Klasse.Verwendete Funktionen aus Utilis:

• findLastValidArchive(source:String,timestamp:datetime))

[VPatrick]

Ich hab mal mit der Dokumentation angefangen. Könnt ihr mir eure Teile der Dokumentation schicken, dann kann ich das alles in einem Dokument zusammenfassen. Den bisherigen Stand der Doku findet ihr als PDF hier: https://github.com/VPatrick/PerlArchiver/tree/master/Dokumente

Zu den Platzhaltern [Beschreibung ...] brauch ich dann noch von euch die Beschreibung der Methoden, Diagramme plus Beschreibung etc. Was euch halt einfällt und notiert werden muss.

[VPatrick]

Folgende Änderungen hat's gegeben:

Utils:

• - message : Message (Klassenvariable)
• + getPathFromHash(hash : string, path : string) : string
• + getAbsPath(path : string) : string

Invoker:

• - utils : Utils (Klassenvariable)
• + printHashTable(arguments : array)

[KasikciMu]

Folgendes hat sich in meiner Klasse geändert: globales Attribut:

• +Flag:boolean

Methorden:

• -DirectoryUp
• +FindArchive()
• +getLinkPath(linkName : String, linkPath : String)

[VPatrick]

Könnt ich schon aber Pages kann die Michaela nicht und der Muhammed hat vermutlich nicht die aktuelle Version. Außerdem kommt GitHub anscheinend nicht so gut mit solchen Formaten zurecht. Wenn ich eure Teile eingebaut hab, dann schick ich euch die Doku im Original (.pages/.docx) per Mail. Dann könnt ihr noch Fehler verbessern etc und bis dahin könnt ihr doch einfach hier ein paar Kommentare schreiben (Fehler auf Seite 9; fehlerhafter Satz => verbesserter Satz)

[VPatrick]

@Ramunno Kannst du das Klassendiagramm für die Übersicht mehr in die Länge ziehen. Ich kann das leider nicht vergrößern weils so breit ist aber so kann man nahezu nichts erkennen. Einfach die Klassen ein wenig umsortieren, das es höher und schmäler wird.

[Ramunno]

@VPatrick Ich hab die Übersicht leider nicht mehr gespeichert. Habe nur noch die detaillierte Ansicht

[VPatrick]

Hm... Kannst du die nochmal machen oder sollen wir's so lassen?

[Ramunno]

Könnte schon, aber das ewig gedauert. Und eigentlich hab ich da keine Lust drauf. Ich muss ja noch die Doku schreiben.

[VPatrick]

Musst du wissen. Der wird uns wegen dem Klassendiagramm bestimmt kei schlechtere Note geben.

[Ramunno]

Kann es sein das GitHub noch nicht eincheckte Sachen löscht. Bei mir ist mein Doku komplett weg!

[VPatrick]

Also GitHub löscht nix von allein. Was sein kann, ist das deine Dateien bei einem Merge gelöscht wurden.

[Ramunno]

Vielleicht hat ja einer ein Verzeichnis umbenannt, oder verschoben! Ich habe auf jeden Fall nichts gemacht und die Datei ist weg!

[VPatrick]

Da kann ich dir leider nicht weiterhelfen. Wie hieß die Datei und in welchem Verzeichnis hätte die sein sollen? Meine Empfehlung ist ja, nur PDFs auf GitHub zu laden und Word oder Pages-Dateien auf dem lokalen System zu belassen.

[Ramunno]

Ja die Datei war ja nur lokal, aber halt im Verzeichnis vom git

[Ramunno]

@all Mal ne Frage macht ihr zu jeder Methode ein Aktivitätsdiagramm?

[VPatrick]

Nein

[KasikciMu]

Nein

[Ramunno]

Oh ich schon :-) @VPatrick Kannst du das Klassendiagramm nicht im Querformat machen, so das es eine ganze Seite ausfüllt, sonst erkennt man echt nicht. Umsortieren geht nicht wirklich, sind zuviel Verbindungen!

[Ramunno]

@VPatrick Nicht sichtbare Hassdatei auf Seite 4 oben ausbessern. Ist sichtbar!

[Ramunno]

Soll ich dann eigentlich mein Doku als PDF oder Pages Datei hochladen?

[VPatrick]

@Ramunno Du erstellst 22 Aktivitätsdiagramme? Die Dokumentation soll fei nur 18 - 20 Seiten lang werden. Schick mir die Pages-Datei bitte per Email. Wenn du willst kannst du auch ein PDF ins Repository laden aber die Email möchte ich trotzdem.

[VPatrick]

@all Hab das mit der "nicht sichtbaren Hashdatei" korrigiert.

[KasikciMu]

@VPatrick Wer dokumentiert die Utils Klasse ^^ :) Soll ich meine Funktionen einfach dokumentieren und du deine?

[VPatrick]

@KasikciMu Wieso soll die Stils-Klasse dokumentiert werden? Ist doch nur ne Hilfsklasse und ist kommentiert aber wir könnens gern so machen.

[KasikciMu]

@VPatrick Wäre dann ein ganz kurzer Abschnitt. Wenigstens wir haben es bisschen erklärt.

[Ramunno]

Naja das Create ist ein bisschen aufwendiger und wenn ich das alles in Prosa erkläre, dann steigt kein Mensch durch! Außerdem soll er sich nicht so anstellen sind ja alles nur Bilder ;-). @VPatrick Du solltest die Diagramm nicht als png einfügen, die sind viel zu unscharf! Öffne einfach das PDF in Vorschau und markiere den Abschnitt den du haben willst, und dann mach Copy & Paste. Dadurch wird es als Vektorgrafik eingefügt. Das kann man dann auch schön zoomen!

[Ramunno]

Ich habe dir die Doku geschickt. Hab dir aus Versehen zuerst die falsche Datei geschickt!

[VPatrick]

@Ramunno Wir sollten auf 18 - 20 Seiten kommen. Im Moment haben wir ohne Deckblatt, Inhaltsverzeichnis und Anhang ca. 8 Seiten. Du musst deine Doku etwas kürzer fassen. Ich kann so nicht alles übernehmen sonst wird das Dokument zu lang. Die anderen müssen ihre Klassen ja auch noch beschreiben. Das Profiling sollte auch erwähnt werden.

@Ramunno Werd das mit den Vektorgrafiken berücksichtigen. Wusste ich bis dato gar nicht :)

@KasikciMu Ich glaube nicht, dass wir Utils mit aufnehmen können. Wir kommen wahrscheinlich überhaupt nicht mit den 20 Seiten hin. Es wird viel zu viel werden. Wenn am Schluss no irgendwo Platz ist, dann kann ich als Lückenfüller vielleicht ein paar Sätze dazu schreiben.

Wir müssen mit der Seitenzahl aufpassen!

[VPatrick]

@Ramunno Er hat in der Aufgabenstellung klar geschrieben, dass detaillierte Diagramme in den Anhang sollen.

[KasikciMu]

@VPatrick Ich weiß nicht auf wie viele Seiten @Ramunno gekommen ist aber bei Restore komme ich auf höchsten 2 Seiten XD

[Ramunno]

Da steht aber auch das der Programmfluss Dokumentiert werden soll. " Beschreiben Sie die Verwendung (User Guide) sowie das Design der Software (data structures, modules, packages, subroutines, program flow, etc.). Hinweis: Programm- fluss kann übersichtlich mit UML Aktivitäts-Diagrammen dargestellt werden." Die anderen Diagramm die du meinst wären Datenstrukturen, detaillierte UML-Diagramme, etc. Ich wüsste nicht was ich da kürzen soll. Da steht ja eh nur das nötigste. Kurze Erklärung was Create macht. Die Sicht des Entwickler-Anwender. Die Sicht des Weiterentwicklers. So wie er es das letzte mal gesagt hat!

[VPatrick]

@Ramunno Aber du erkennst doch das Problem, dass wir wenn ich deine 10 Seiten so einfüge schon bei 18 Seiten sind und die anderen ihre Teile auch noch beschreiben müssen. Du kannst dich ja mal beim Hein schlau machen, ob die Seitenzahl nur das Mindestmaß ist, also ob wir auch mehr als 20 Seiten schreiben dürfen. Wenn dem so ist, dann hab ich kein Problem damit aber anderenfalls muss dein Part kürzer werden!

[KasikciMu]

@Ramunno HAHAHA Hast du Schriftgröße 30 genommen XD

[Ramunno]

@VPatrick Warum fragst du Ihn nicht? Ich habe irgendwie nicht so einen guten Draht zu Ihm! Kannst du mir erzählen was ich an der Doku kürzen soll. Ich beschreibe nur die Methoden, in einem Satz, dann noch Parameter und Rückgabewerte. Dann wie man die Use-Case verwendet. Und was Create überhaupt macht. Ich sehe da kein Kürzungspotenzial. Hatte er nicht mal gemeint das es keine Fixe Seitenzahl ist? Du kannst ja die Diagramm vielleicht ein bisschen verkleinern oder anders anordnen. Außerdem sind es nur 9 Seiten!

[Ramunno]

Ich hab die Doku von Create auf git hochgeladen. https://github.com/VPatrick/PerlArchiver/blob/master/Dokumente/Dokumentation%20Create.pdf

[VPatrick]

Hab dem Hein grad ne Mail geschrieben ob wir auch mehr als 20 Seiten schreiben dürfen.

---

Sehr geehrter Herr Hein,

ich hätte eine Frage bezüglich der Seitenanzahl der Projektdokumentation von unserem Archivierungsprojekt in Systemprogrammierung mit Perl. In Ihrer Aufgabenstellung ist die angegebene Seitenzahl 18 - 20 Seiten. Ist dies das Mindestmaß oder dürfen wir auch mehr schreiben? Im Moment kommen wir, wie aussieht, wohl auf knapp 30 Seiten (mit Diagrammen und der Beschreibung aus Sicht eines normalen Anwenders, eines Administrator und eines Entwicklers).

Mit freundlichen Grüßen, Patrick Vogt

[KasikciMu]

@VPatrick Welche E-Mail Adresse :D

[Ramunno]

Alles klar dann bin ich mal gespannt!

[KasikciMu]

@VPatrick @Ramunno @mia8287 Welche Schriftart verwenden wir oder machst es @VPatrick ?

[VPatrick]

Ich kümmere mich um Schriftart, Größe, Zeilenabstand, Einzüge, ...

[Ramunno]

@VPatrick Lade mal die Pages-Datei hoch. Die Dokumentation hat einige Fehler innen. Ich bessere es mit Änderungsverfolgung aus. Die Abstände sind viel zu groß und muss das Profiling 4 Seiten haben?

[Ramunno]

Außerdem haben wir noch 6 Seiten frei!

[VPatrick]

Habs hochgeladen. Machs gleich ohne Änderungsverfolgung, dann muss ich das nicht mehr nachtragen. Wenn du noch Material zum Füllen für die 6 Seiten hast, dann kannst es gleich rein machen und lass das Profiling doch 4 Seiten haben.