Guten Morgen zusammen. Mein heutiger Post ist ganz simpel deshalb gehalten, um zu sagen warum Dokumentationen, meiner Meinung nach wichtig sind.
Open Source Software ist toll, aber wenn man nicht in der Lage ist den Code zu verstehen, so sollte man die Software doch dennoch nutzen können, meint ihr nicht?
Das Problem ist folgendes, ich habe einen Simulator für die AVRs von ATMEL runtergeladen, welches open source ist. Es wird auch überall auf die ach so tollen Features des Programmes eingegangen, nur was bringt es, wenn man es nur nutzen kann, wenn man den Code solange liest, bis man versteht wie es funktioniert? Ist das der Sinn von Open Source?
Ganz ehrlich, dann kann ich mir den Simulator auch gleich selbst schreiben, dann weiß ich auch was er tut. Jede Software sollte dokumentiert sein, einmal im Code für jene die das Projekt mit-/weiterentwickeln wollen und einmal so, das User die sich nicht mit dem Code auskennen die Software schnell und ohne große Probleme nutzen können.
Mir fehlt eben jene Dokumentation von SimAVR, es mag sein das ich gelesen habe, der Autor der Software habe schön und gut alles im Code dokumentiert, aber was bringt es mir? Ich kenne mich in dem Code nicht aus und weiß nicht an welche Stelle ich gucken muss um genau "DIESEN" Kommentar zu finden, der mich nun weiter bringt. Das Readme-File ist genauso kurz wie nichtssagend gehalten, als auch die Wiki-Page, die eher eine Aufzählung der Features ist.
Meine einzige Hoffnung ist nun die Mailing-Liste, denn eventuell kann man so mal den Weg für eine Dokumentation anstoßen. Es scheint das Programm sei sehr gut und es scheint auch viel zu unterstützen, jetzt fehlt nur noch die Dokumentation dafür.
Was meint ihr? Ist es wirklich unnötig für Open Source Software eine Dokumentation zu schreiben, da ja eh jeder selbst den Code ansehen kann um zu verstehen was wie funktioniert?
Das ist eine der Fragen die ich anstoßen wollte und auch gleich den Gedanken, dass Dokumentationen, egal ob unfreie/freie Software wichtig sind.
Falls jemand SimAVR kennt und mir helfen kann, wäre ich ihm sehr verbunden sich erstmal per Kommentar zu melden.
Hier kommt ihr zur Projektseite von SimAVR
0 Kommentare:
Kommentar veröffentlichen