S
Stefan Reuther
Guest
Dirk Ruth wrote:
Hier wird selbstverständlich das Relevante aus den Emails
rausdestilliert und thematisch sortiert im Projektordner abgelegt. Es
nutzt ja keinem was, wenn die Absprache in meinem Email-Programm
vergammelt, während ich mir drei Wochen die Sonne auf den Bauch scheinen
lasse.
QM will übrigens genau die Gegenrichtung. QM will Dokumentation "vom
Pflichtenheftkapitel zum Code". Und ehrlich gesagt ist das auch bei mir
der häufigste Anwendungsfall. Ich stehe sehr selten vor dem Problem,
dass ich mir auf gut Glück die Datei 'fdctrl.cpp' rauspicke und dann
deren Designprinzipien wissen will. Real will ich wissen, wie die
Zufuhreinheit meines Pudelentkerners gesteuert wird. Also hangle ich
mich vom Systemdesign zum Modul 'Feeder Control' durch, und erfahre
dort, dass das in 'fdctrl.cpp' implementiert ist.
(zumindest meiner) noch nicht mal besonders häufig ist, dafür die
komplette Projektverwaltungsstruktur umkrempeln und allen Entwicklern
ein neues Tool aufnötigen. Da braucht's schon bessere Argumente als
nichtklickbare Verweise (unser Wiki kann übrigens auf den Bugtracker und
den Fileserver linken und zurück. Und wenn wir ein CVS-Web hätten,
könnter der Bugtracker sicher auch darauf linken. Die Felder gibt es
jedenfalls).
von der Hand gehen, die ich täglich hundertfach tue, nicht die, die ich
einmal die Woche tue. MultiWortBezeichner und Ausdrücke manipulieren
sind da einfach wichtiger als Unterstützung für das neugierige Schmökern
in fremdem Quellcode.
gibt für den Entwurf tolle teure UML-Werkzeuge. Und für die Verwaltung
und Verschlagwortung von Dokumenten gibt es tolle teure Dokumenten-
management-Systeme.
Realisierung von Dokumentation. Du wolltest vor allem die Verlinkung von
Code zu Doku. Meine Meinung: das ist kein Problem, das Toolunterstützung
braucht, weil es für seinen geringen Nutzen viel zu stark in den
Arbeitsprozess eingreifen würde.
Insbesondere löst es auch nicht das Problem, wo man dann Entwurfs-
Dokumente zu nicht in Software umgesetzten Teilen unterbringt. Neben
abgelehnten Änderungswünschen ("kostet 2 Mannjahre das zu
implementieren, zu teuer") wären das zum Beispiel auch Leiterplatten-
Entwürfe, immerhin sind wir ja hier in dse
Stefan
Nur in unorganisierten Projekten bleiben sie das auch.Stefan Reutherschrieb:
Dirk Ruth wrote:
Mein Ansatz ist eher ein anderer.
Es ging mir nicht darum, neben der Codierung gleich die Doku
mitzuschreiben. Ich möchte vielmehr alle Informationen, die zur
Projektlaufzeit einlaufen den einzelnen Code-Bestandteilen zuordnen,
weil ich nach einen Jahr nicht in tausend Emails herumsuchen möchte,
wer, wann, was gesagt hat.
Damit ich dann nicht in "tausend Emails", sondern in "tausend
Quelldateien" suchen muss, klar.
Der Ansatz ist hier nicht von der Email zum Code, sondern vom Code zur
Email.
Emails sind in der Regel chronologisch geordnet.
Hier wird selbstverständlich das Relevante aus den Emails
rausdestilliert und thematisch sortiert im Projektordner abgelegt. Es
nutzt ja keinem was, wenn die Absprache in meinem Email-Programm
vergammelt, während ich mir drei Wochen die Sonne auf den Bauch scheinen
lasse.
QM will übrigens genau die Gegenrichtung. QM will Dokumentation "vom
Pflichtenheftkapitel zum Code". Und ehrlich gesagt ist das auch bei mir
der häufigste Anwendungsfall. Ich stehe sehr selten vor dem Problem,
dass ich mir auf gut Glück die Datei 'fdctrl.cpp' rauspicke und dann
deren Designprinzipien wissen will. Real will ich wissen, wie die
Zufuhreinheit meines Pudelentkerners gesteuert wird. Also hangle ich
mich vom Systemdesign zum Modul 'Feeder Control' durch, und erfahre
dort, dass das in 'fdctrl.cpp' implementiert ist.
Sorry, du willst *einen* Anwendungsfall vereinfachen, der in der PraxisUnd diese Verweise landen dann, wo nötig, in regulären Quellcode-
kommentaren und auf jeden Fall im Commit-Kommentar zum entsprechenden
Changeset im Versionierungssystem ("startup.c, calib.c: beim Systemstart
Hypothenuse kalibrieren. Behebt Fehler #3492", und im Ticketsystem
"Fehler behoben mit startup.c 1.47, calib.c 1.119").
Kann man so machen. Ich will aber komfortabel arbeiten, und deshalb
sollen diese Verlinkungen für mich transparent sein.
(zumindest meiner) noch nicht mal besonders häufig ist, dafür die
komplette Projektverwaltungsstruktur umkrempeln und allen Entwicklern
ein neues Tool aufnötigen. Da braucht's schon bessere Argumente als
nichtklickbare Verweise (unser Wiki kann übrigens auf den Bugtracker und
den Fileserver linken und zurück. Und wenn wir ein CVS-Web hätten,
könnter der Bugtracker sicher auch darauf linken. Die Felder gibt es
jedenfalls).
Ich will auch komfortabel arbeiten. Und ich will, dass die Dinge flottJa, es gibt Leute, die mit so einer Krücke wie Visual Studio Texte
erfassen. Also quasi einem aufgebohrten Notepad. Die wissen nur meistens
einfach nicht, dass es besseres gibt. Und zwar nicht "besser" as in
"zwei Editierfunktionen mehr", sondern "zwei Zehnerpotenzen mehr". Als
ich das letzte mal nachgeschaut hatte, hatte Visual Studio immer noch
nicht das für Windows-Programmierung eigentlich essenzielle
c-forward-into-nomenclature, und Ausdrücke gescheit einrücken konnte er
auch nicht.
Na wenn das die entscheidenden Kriterien für dich sind.
von der Hand gehen, die ich täglich hundertfach tue, nicht die, die ich
einmal die Woche tue. MultiWortBezeichner und Ausdrücke manipulieren
sind da einfach wichtiger als Unterstützung für das neugierige Schmökern
in fremdem Quellcode.
Doch natürlich. Es gibt tolle teure Anforderungsmanagement-Werkzeuge. EsVor dem Codieren gibt es einen Entwicklungsprozess, das eigendliche
Software entwickeln. Da gibt es Diskussionen, Vorschläge, es werden
Algorithmen entwickelt, simuliert und z.T. wieder verworfen usw. und
zum Schluss fällt der Code heraus, der im Editor eingegeben wird.
Für den allerletzten Teil, das Codieren, gibt es eine Unmenge an
Werkzeugen wie Editoren und Entwicklungsumgebungen.
Für die ersten großen und eigendlich wichtigsten Teile gibt es aber
anscheinend kein geeignetes und komfortables Werkzeug.
gibt für den Entwurf tolle teure UML-Werkzeuge. Und für die Verwaltung
und Verschlagwortung von Dokumenten gibt es tolle teure Dokumenten-
management-Systeme.
Das sind Äpfel und Birnen. LaTeX und ASCII-Art sind Möglichkeiten zurAlso das Zusammenführen aller Teilergnisse/Infos aus den spezialisierten
Anwendungen (Mathematika, Visio,Email usw. wurden genannt) und eine
direkte thematische Zuordnung aus dem Code zu all diesen
Informationen.
Jeder kocht hier, wie ich gesehen habe jeder sein eigenes Süppchen.
Die Einen verwenden LaTex, die anderen schreiben Text-Links auf
Dokumente in der Versionsverwaltung in den Code und wieder andere
machen das mit ASCII-Art.
Realisierung von Dokumentation. Du wolltest vor allem die Verlinkung von
Code zu Doku. Meine Meinung: das ist kein Problem, das Toolunterstützung
braucht, weil es für seinen geringen Nutzen viel zu stark in den
Arbeitsprozess eingreifen würde.
Insbesondere löst es auch nicht das Problem, wo man dann Entwurfs-
Dokumente zu nicht in Software umgesetzten Teilen unterbringt. Neben
abgelehnten Änderungswünschen ("kostet 2 Mannjahre das zu
implementieren, zu teuer") wären das zum Beispiel auch Leiterplatten-
Entwürfe, immerhin sind wir ja hier in dse
Stefan