![]() |
Software-Dokumentation
Hallo Delphi-Gemeinde!
Ich habe im Zuge meines Studiums die Aufgabe bekommen, eine Software zu entwicklen. Dazu soll ich eine Dokumentation schreiben, am besten so, dass auch später andere Entwickler etwas damit anfangen können. Nun habe ich schon etwas im Internet recherchiert aber leider keine konkreten Informationen finden können. Ich suche eigentlich soetwas wie eine kleine Anleitung zum Thema Software-Dokumentation. Da sich hier ja nun schon einige erfahrene Entwickler finden, wollte ich nun einfach mal direkt fragen. Wie schreibt ihr solche Dokumentationen, einfach so "frei Hand" oder gibt es dazu vielleicht irgendwelche Vorlagen, an denen man sich orientieren könnte? Und was soll eigntlich in so einer Dokumentation stehen, was ich wichtig für Entwickler, was ist wichtig für die Anwender? Ich bin für alle Tipps dankbar, die mir da weiterhelfen könnten! :zwinker: Vielen Dank! Gruß |
Re: Software-Dokumentation
Stelle dir mal zuerst die frage, was du selber von einer "dokumentation" erwartest. Beispiele gibt es in jedem handbuch.
|
Re: Software-Dokumentation
Hallo
Wenn es darum geht das sich andere Entwickler zurechtfinden dann empfehle ich die Dokumentation im Quellcode ! Mit Programmen wie pasdoc ... kannn aus diesen Kommentaren eine Dokumentation erstellt werden. mfg Reinhold -------------- ![]() |
Re: Software-Dokumentation
Zitat:
Der Grund ist, dass ich zwar auch möglicherweise mal ein anderer Entwickler in dem Code zurecht finden soll, aber es geht mir auch zu einem großen Teil darum, meine Arbeit zu dokuemtieren, da ich das Programm dann auch abgeben werde. Zitat:
Was wäre denn z.B. ein Handbuch, in dem ich dazu nährere Informationen finden könnte? Zitat:
Gibt es denn z.B. so etwas wie Gundregeln, z.B. was dokumentiere ich eigentlich, was nicht? Oder was muss ich genauer erläutern und was ist selbsterklärend? Gruß |
Alle Zeitangaben in WEZ +1. Es ist jetzt 19:58 Uhr. |
Powered by vBulletin® Copyright ©2000 - 2025, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz