|
|
|
Software-Dokumentation, Handbuch, Spezifikationen |
|
| Seban |
Forum-Meister
|
 |
Beiträge: 600
|
|
|
|
Anmeldedatum: 19.01.12
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ab R2014b
|
|
|
|
 |
|
Verfasst am: 08.02.2013, 18:43
Titel: Software-Dokumentation, Handbuch, Spezifikationen
|
 |
| |
 |
 |
Hallo,
Ich bin kein Programmierer oä und kenne mich in diesen Bereichen leider nicht aus. Daher hoffe ich auf den ein oder anderen guten Tipp/Link/Buchempfehlung/Stichworte/Uni-Skripte oä.
Ich arbeite als HiWi an einem Projekt, das bisher großteils von anderen erstellt wurde und kaum dokumentiert wurde. Da es mittlereweile recht umfangreich geworden ist und zukünftig auch andere daran arbeiten werden, soll sich dies nun ändern. Ziele sind Nachvollziehbarkeit, Erleichtertes Einarbeiten, Übersichtlichkeit... also nicht Quellcodedokumentation, sondern Projekt-/Entwicklungsdokumentation (oder wie man das nennen mag, ich weiß es um ehrlich zu sein nicht)
Einige Stichpunkte, was so im Raum steht:
Entwicklerhandbuch anlegen:
Sinn & Zweck des Programms
Konzeption
Modularer Aufbau/Entwicklung
primäre Aufgaben (Projektverwaltung, Datenim-/export, Datenverarbeitung, Visualisierung(, Reporting))
Ich weiß nicht was noch hier rein gehört, vllt gibt es für so etwas Vorlagen? Lasten- / Pflichtenhefte erscheinen mir zu umfangreich.
uU Erläuterungen zum Revisionsprogramms, das hoffentlich bald eingesetzt wird.
Erläuterungen zur In/Deinstallation, Erstellung des Installers etc.
Spezifikationen:
Aufbau Datenstruktur ist und soll
wie wird auf die Daten zugegriffen, welche Fkt greifen zu
Auch Testing soll eine Rolle spielen, man soll zukünftig einfacher einzelne Funktionen/GUI testen können (durch zu Verfügugnstellen entsprechender daten etwa)
Funktionsumfangd er GUIs, was kann man machen, was passiert wenn ich Button xy klicke usw. Anforderungen/Funktionsaufrufe...
-> Das & weiteres soll spezifiziert werden. Gibt es dazu Literatur/Skripte, wie man am besten vorgeht? Was man beachten sollte? Auch zu Struktur, Form (Textform, Diagramme, Excellisten...)?
Würd mich freuen, wennd er ein oder andere ein paar Infos zur Hand hat.
Grüße,
Seban
PS Auch Links zu Foren, die sich allgemein mit Programmieren/Softwareentwicklung beschäftigen, würden mich freuen.
_________________
Richtig fragen
Debugging
|
|
|
|
|
|
| Jan S |
Moderator
|
|
Beiträge: 11.057
|
|
|
|
Anmeldedatum: 08.07.10
|
|
|
|
Wohnort: Heidelberg
|
|
|
|
Version: 2009a, 2016b
|
|
|
|
|
|
|
Verfasst am: 08.02.2013, 20:23
Titel: Re: Software-Dokumentation, Handbuch, Spezifikationen
|
|
| |
|
|
Hallo Seban,
| Zitat: |
| Ich bin kein Programmierer oä und kenne mich in diesen Bereichen leider nicht aus. ... Ich arbeite als HiWi an einem Projekt, das bisher großteils von anderen erstellt wurde und kaum dokumentiert wurde. |
Die Dokumentation fremden Codes, bei der bisher nicht sauber dokumentiert wurde, ist ein "Brown-Field-Project". Das heißt so, da man sich im Gegensatz zu einem Green-Field-Project, bei dem von vornherein klar und logisch strukturiert neben der Programmierarbeit auch das Design und die Qualitätskontrolle des Projekts dokumentiert wurde, fühlt, als würde man mit dem Gesicht im Schlamm stecken. Stichwort: Die Karre aus dem Dreck ziehen...
Wenn Du kein erfahrener Programmierer bist und auch nicht einige Jahre im Projekt-Managment gearbeitet hast, ist dies ein sehr schwere Aufgabe. Wenn "recht umfangreich" etwas mit mehr als 100'000 Zeilen Code bedeutet, kann die Einarbeitung in das Programm, Auswahl der Dokumentations-Struktur und sinnvolle Ausführung sehr aufwändig sein. Wieviele Monate sind denn für das Projekt vorgesehen?
Suche im Netz nach "Brown-Field", z.B. http://en.wikipedia.org/wiki/Brownf.....28software_development%29. Eine Diskussion über Testing gab es gerade hier: http://www.gomatlab.de/unit-tests-komponententest-t27480.html. Aber wirklich hilfreiche Links habe ich nicht, da das Thema wirklich eine große Herausforderung ist.
Gruß, Jan
|
|
|
|
| Seban |
Themenstarter
Forum-Meister
|
|
Beiträge: 600
|
|
|
|
Anmeldedatum: 19.01.12
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ab R2014b
|
|
|
|
|
|
|
Verfasst am: 10.02.2013, 13:28
Titel: Re: Software-Dokumentation, Handbuch, Spezifikationen
|
|
Danke, Jan.
Der Name erscheint mir momentan relativ passend 
Es sind bisher ca 24000 Zeilen Code, eine zeitliche Planung steht soweit ich weiß noch nicht.
Ich werd morgen mal ausführlich Google bemühen, um mir einen besseren Überblick zu verschaffen und passende Ansatzpunkte zu finden.
Grüße
_________________
Richtig fragen
Debugging
|
|
|
|
|
|
|
Einstellungen und Berechtigungen
|
|
Du kannst Beiträge in dieses Forum schreiben.
Du kannst auf Beiträge in diesem Forum antworten.
Du kannst deine Beiträge in diesem Forum nicht bearbeiten.
Du kannst deine Beiträge in diesem Forum nicht löschen.
Du kannst an Umfragen in diesem Forum nicht mitmachen.
Du kannst Dateien in diesem Forum posten
Du kannst Dateien in diesem Forum herunterladen
|
|
Impressum
| Nutzungsbedingungen
| Datenschutz
| FAQ
|  RSS
Hosted by:
Copyright © 2007 - 2024
goMatlab.de | Dies ist keine offizielle Website der Firma The Mathworks
MATLAB, Simulink, Stateflow, Handle Graphics, Real-Time Workshop, SimBiology, SimHydraulics, SimEvents, and xPC TargetBox are registered trademarks and The MathWorks, the L-shaped membrane logo, and Embedded MATLAB are trademarks of The MathWorks, Inc.
|
|
