AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Sprachen und Entwicklungsumgebungen Sonstige Fragen zu Delphi Delphi Dokumentation für Programm erstellen
Thema durchsuchen
Ansicht
Themen-Optionen

Dokumentation für Programm erstellen

Ein Thema von Kaiborg · begonnen am 23. Nov 2003 · letzter Beitrag vom 6. Jan 2004
Antwort Antwort
Seite 1 von 2  1 2      
Kaiborg

Registriert seit: 3. Nov 2003
11 Beiträge
 
Delphi 5 Enterprise
 
#1

Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 11:50
Hi!

Ich habe für die Schule ein Projekt geschrieben, was noch nich 100%ig funktioniert , mein Infolehrer war damit nich ganz einverstanden, und hat gesagt, er möchte dazu dann bitte eine Dokumentation haben , nur leider hat er nich gesagt, wie man eine Dokumentation zu schreiben hat , und auch nach intensiver Internetsuche habe ich keine vernünftige Anleitung dazu gefunden.
Wär schön, wenn mir jemand weiterhelfen könnte.
Danke im Voraus
  Mit Zitat antworten Zitat
CalganX

Registriert seit: 21. Jul 2002
Ort: Bonn
5.403 Beiträge
 
Turbo Delphi für Win32
 
#2

Re: Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 12:00
Hi,
du hast eigentlich da Freiheit. Zumindest was das Format angeht. Meistens schreibe ich Dokumentationen in PDF (LaTeX bei mathematischen Sachen oder OpenOffice.org bei anderen Dingen). Allerdings kannst du das ganze auch in Form einer OnlineHilfe schreiben (.chm) oder ein einfaches Worddokument schreiben.
Zu Allen Möglichkeiten findest du in der DP was entsprechendes.

Der Aufbau sollte - meiner Meinung nach - ungefähr so aussehen:
  1. Einführung - Was macht dein Progamm? Womit hast du es geschrieben? Was ist der Sinn? etc.
  2. Dateien - Welche Dateien liegen dem Programm bei? Welche Funktion hat welche Datei? etc.
  3. Algorithmen - Welches Problem soll das Programm lösen? Welchen Algorithmus hast du verwendet? etc.
  4. Source-Dokumentation - Welche Funktion macht was? Erkläre den SourceCode! etc. (nur bei OpenSource)
  5. Abschluss - Quellen der Algorithmen, Dank ( ), etc.

Das im Groben. So sieht's bei mir zumindest meistens aus.

Chris
  Mit Zitat antworten Zitat
Benutzerbild von HAF4ever
HAF4ever

Registriert seit: 31. Okt 2003
Ort: Enns - Österreich
37 Beiträge
 
#3

Re: Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 12:03
oder einfach nur ein paar (* kommentare *) einfügen ...
wo halt drinnen steht was das prog macht bzw. machen soll
gtg, no time, can't talk, get watched, .....
  Mit Zitat antworten Zitat
Kaiborg

Registriert seit: 3. Nov 2003
11 Beiträge
 
Delphi 5 Enterprise
 
#4

Re: Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 12:06
Ok, danke!

Dann werde ich das mal noch bis morgen machen, sieht ja nicht so schwer aus , aber eine Frage noch, muss der Quellcode rein??
  Mit Zitat antworten Zitat
Benutzerbild von HAF4ever
HAF4ever

Registriert seit: 31. Okt 2003
Ort: Enns - Österreich
37 Beiträge
 
#5

Re: Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 12:12
der ganze source zahlt sich nicht aus ...
aber den code der wichtigsten prozeduren und funktionen schadet sicher nicht ...
gtg, no time, can't talk, get watched, .....
  Mit Zitat antworten Zitat
Benutzerbild von Luckie
Luckie

Registriert seit: 29. Mai 2002
37.621 Beiträge
 
Delphi 2006 Professional
 
#6

Re: Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 14:57
Zu den Algorithmen sollte man noch die mathematischen Grundlagen etwas erörtern. Und zum Schluss gehören da noch ein paar Testeingaben mit den Ausgaben dabei, sowohl Extremwerte, als auch normale. Und dabei müssen auch die Grenzen aufgeziegt werden, also bei welchen Werten dein Programm versagt.
Michael
Ein Teil meines Codes würde euch verunsichern.
  Mit Zitat antworten Zitat
Karsten

Registriert seit: 5. Sep 2003
56 Beiträge
 
Delphi 6 Personal
 
#7

Re: Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 15:16
Die Funktionen sollten anhand von Flow-Charts beschrieben werden (nur die wichtigen, um prinzipielle Funktionsweisen zu erklären) und auf keinen Fall Quellcode in die Dokumentation reinnehmen.

Und wie Luckie schon sagte, 'mathematische Grundlagen' sind immer wieder sehr geeignet und auch wichtig.

Sollte sich irgenwann mal diese Frage während einer Diplomarbeit oder ähnliches stellen, kann ich da nur auf Erfahrungswerte zurückgreifen:

Note 1-2 bei denen die auf Quellcode verzichten und sich um prinzipielle Dinge gedanken machen

Note 3-4 bei denen die den Quellcode ans Ende kopieren um die Anzahl der Seiten zu erhöhen.

Gruß,
Karsten
  Mit Zitat antworten Zitat
fenni

Registriert seit: 21. Nov 2003
Ort: 57648 Unnau
13 Beiträge
 
Delphi 6 Personal
 
#8

Re: Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 16:45
Wichtig ist auch eine Erklärung, dass du das Programm ohne fremde Hilfe erstellt und eventuelle externe Quellen angegeben hast.

Der Quellcode gehört wenn überhaupt nur in den Anhang, ich würde ihn aber ganz weglassen und nur die wichtigsten Funktionen/Prozeduren in einem extra Kapitel über den Programmablauf an sich erläutern.

MfG
fenni
  Mit Zitat antworten Zitat
Benutzerbild von HAF4ever
HAF4ever

Registriert seit: 31. Okt 2003
Ort: Enns - Österreich
37 Beiträge
 
#9

Re: Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 17:09
wenn man schon keinen quellcode reinschreiben soll ...
wie siehts mit ablaufdiagrammen aus...? macht das einen guten eindruck wenn man für die wichtigsten algorythmen solche diagramme dazuzeichnet?
gtg, no time, can't talk, get watched, .....
  Mit Zitat antworten Zitat
Hansa

Registriert seit: 9. Jun 2002
Ort: Saarland
7.554 Beiträge
 
Delphi 8 Professional
 
#10

Re: Dokumentation für Programm erstellen

  Alt 23. Nov 2003, 17:20
Je nachdem, was Du genau jetzt meinst, vielleicht ja etwas anderes als ich, aber sehe ich irgendwo so ein paar bunte Bauklötze, Pfeile, die ins Nirwana zeigen und so nen Kram, dann hat dieses Programm bei mir schon verloren. Wie gesagt, nur meine Meinung Steht Dein Pauker auf so nem Kram, dann mach es halt.
Gruß
Hansa
  Mit Zitat antworten Zitat
Antwort Antwort
Seite 1 von 2  1 2      


Forumregeln

Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are aus

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 00:21 Uhr.
Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz