runtimeterror
Moderator
Hi zusammen,
ich habe die Frage schonmal gestellt, aber keine zufriedenstellende Anwort erhalten: Warum ist die Dokumentation des Projektes so "unergonomisch"?
Es gibt es zahlreiche Informationsquellen, auf die man verwiesen wird. Bislang gefunden habe ich:
- Das wiki auf Deutsch und Englisch
- Das Forum auf Deutsch und Englisch
- Die ardumower.de-Startseite
- Diverse Unterseiten unter ardumower.de
- Die github-Projekte
- Diverse Youtube-Videos, deren Beschreibung und die Kommentarbereiche darunter
- Datenblätter und Produktbeschreibungen im Marotronics-Shop
- Die Schaltpläne PDFs und PCB in Kicad
Teilweise widersprechen sich die Informationen und häufig ist nicht klar was der aktuelle Stand ist bzw. zu welchem Entwicklungsstand die Dokumentation oder die Bilder gehören.
Was mir persönlich konkret nicht gefällt:
- Die Startseite verweist zahlreiche Male für alle mögliche Belange ins wiki, der Link ist aber sicher nicht der richtige.
- Die Rolle des wiki wird auf der Startseite nicht geklärt
- Das Forum wird benutzt um Inhalte einzupflegen, die eigentlich ins wiki gehören. Woher soll man wissen wo sich die ganzen Anleitungen verstecken? Im wiki ist ein alter Thread für den Chassis-Zusammenbau verlinkt, wo der Autor selbst noch offene Fragen hat. Ist die Anleitung jetzt korrekt und noch aktuell? Ich habe im Forum eine besser gemachte aktuellere Anleitung gesehen. Warum wurde die nicht im wiki erstellt oder verlinkt? Ich muss jetzt das Forum danach durchsuchen und Neulinge finden die überhaupt nicht.
- Videos statt bebilderter Anleitung. Die Videos sind eine nette Ergänzung aber ansonsten meiner Meinung nach ein ungeeignetes Medium für eine Dokumentation. Man kann schlecht darüber Diskutieren, schlecht Details verlinken, Das Ändern von Kleinigkeiten ist nicht möglich. Video werden erfahungsgemäß wegen des hohen Aufwandes nicht mehr gepflegt und wenn überhaupt werden Errata dazugelegt, die man wiederum finden und in Relation setzen muss (à la: die Schraube bei Minute 1:23 muss eine M6 statt einer M8 sein). In Textform korrigiert man das einfach und gut ist.
- Ich finde den Deutsch/Englisch-Mischmasch extrem störend. Zum einen muss die Dokumentation doppelt gepflegt und synchron gehalten werden, was unnötigen Aufwand bedeutet. Ausländische Projektnutzer düften davon abgeschreckt werden, dass viele wichtige Diskussionen in Deutsch geführt werden (meinen größten Respekt an Bernard!). Deutsche Projektteilnehmer wissen nicht wo/wie sie ihre Fragen stellen sollen und im Deutschen Forum wird ohnehin früher oder später ins Englische gewechselt. Ich weiß, dass einige hier mit der Sprachbarriere zu kämpfen haben, das haben aber die ausländischen Teilnehmer meist auch.
- in Github gibt es einen Bugtracker, den anscheinend keiner moderiert; zudem ist das ardumower-Projekt als HTML gekennzeichnet.
Ich bin als Anfänger in diesem Projekt ganz sicher nicht in der Position Forderungen zu stellen, aber ich (und den Beiträgen im Forum, bei Youtube, etc.) nach zu urteilen bin ich nicht der einzige, der mit der Dokumentationssituation unzufrieden ist. Die Macher des Projektes haben ganz sicher besseres zu tun als immer wieder dieselben Fragen zu beantworten und den Leuten zu erklären, dass sie für einige Fragen erstmal KiCAD in einer dev-Version installieren müssen um bestimmte Details zu erfahren.
Ich helfe gerne mit, die Dokumentation zu verbessern, aber ich habe selbst extrem Mühe alle Infos zusammenzubekommen. Bislang habe ich nicht viel Rückmeldung zu meinen offnen Fragen bekommen. Ich arbeite auch an anderen Projekten mit und habe berufsbedingt auch seit Jahren mit weitaus größeren Kalibern zu tun. Ich kann hier gerne mit meinen Erfahrungen unterstützen.
Ein paar Vorschläge zur Diskussion:
- Alles auf Englisch, dafür nur noch in einfacher Ausführung.
- Eine möglichst klare Trennung der Informationsplattformen:
- - ardumower.de Startseite: Kurze bebilderte Projektvorstellung mit Wegweiser zu allen aktiv gepflegten Informationsquellen
- - ardumower.de Unterseiten: Ich habe das Gefühl, dass die alle vor dem Wiki entstanden sind und nur noch bedingt aktuell sind. Die Seiten sollte als "veraltet" gekennzeichnet werden und/oder ins wiki übertragen werden.
- - das wiki als führende Informationsquelle. Ziel sollte es sein, dass jede Frage, die mehr als einmal gestellt wird im wiki dokumentiert wird und im Forum darauf verwiesen wird.
- - Github als führende Quelle für den aktuellen Entwicklungsstand und die Verwaltung der offenen Bugs. Außerdem fänd ich eine bessere Trennung des Repositories extrem sinnvoll. z.B. je ein Projekt für: Azurit, Raindancer, Sunray, Chassis, PCB 1.3, Perimeter-Sender, Arduremote, Bumperduino, ggf. ardumower.de. Ich denke, das lässt sich ziemlich sauber trennen.
- - Der Bugtracker unter GitHub ist ein extrem wichtiges Werkzeug. Wenn bei mir etwas nicht funktioniert, ist das normalerweise nach der Anleitung im wiki die erste Quelle, die ich konsultiere.
- - Das Forum als Diskussionsplattform für individuelle Belange. Von hier können Nutzer ans wiki (für Anleitungen und Doku), an Github (für Bugs) oder an den Shop verwiesen werden.
Wo ich mir nicht sicher bin ist die Frage, was mit den vielen Blog-ähnlichen Threads passieren soll. Da sind tolle Sachen bei, die aber bei rückläufiger Aktualisierungsrate aus den Augen verschwinden. Vielleicht sollte man diese irgendwo im wiki als Link ins Forum sammeln.
Ich bitte um Entschuldigung, wenn ich hier Dinge vorschlage, die bereits umgesetzt oder diskutiert wurden. Ich habe wie gesagt echt Mühe den aktuellen Stand zu erfassen.
Schöne Grüße,
Kai
ich habe die Frage schonmal gestellt, aber keine zufriedenstellende Anwort erhalten: Warum ist die Dokumentation des Projektes so "unergonomisch"?
Es gibt es zahlreiche Informationsquellen, auf die man verwiesen wird. Bislang gefunden habe ich:
- Das wiki auf Deutsch und Englisch
- Das Forum auf Deutsch und Englisch
- Die ardumower.de-Startseite
- Diverse Unterseiten unter ardumower.de
- Die github-Projekte
- Diverse Youtube-Videos, deren Beschreibung und die Kommentarbereiche darunter
- Datenblätter und Produktbeschreibungen im Marotronics-Shop
- Die Schaltpläne PDFs und PCB in Kicad
Teilweise widersprechen sich die Informationen und häufig ist nicht klar was der aktuelle Stand ist bzw. zu welchem Entwicklungsstand die Dokumentation oder die Bilder gehören.
Was mir persönlich konkret nicht gefällt:
- Die Startseite verweist zahlreiche Male für alle mögliche Belange ins wiki, der Link ist aber sicher nicht der richtige.
- Die Rolle des wiki wird auf der Startseite nicht geklärt
- Das Forum wird benutzt um Inhalte einzupflegen, die eigentlich ins wiki gehören. Woher soll man wissen wo sich die ganzen Anleitungen verstecken? Im wiki ist ein alter Thread für den Chassis-Zusammenbau verlinkt, wo der Autor selbst noch offene Fragen hat. Ist die Anleitung jetzt korrekt und noch aktuell? Ich habe im Forum eine besser gemachte aktuellere Anleitung gesehen. Warum wurde die nicht im wiki erstellt oder verlinkt? Ich muss jetzt das Forum danach durchsuchen und Neulinge finden die überhaupt nicht.
- Videos statt bebilderter Anleitung. Die Videos sind eine nette Ergänzung aber ansonsten meiner Meinung nach ein ungeeignetes Medium für eine Dokumentation. Man kann schlecht darüber Diskutieren, schlecht Details verlinken, Das Ändern von Kleinigkeiten ist nicht möglich. Video werden erfahungsgemäß wegen des hohen Aufwandes nicht mehr gepflegt und wenn überhaupt werden Errata dazugelegt, die man wiederum finden und in Relation setzen muss (à la: die Schraube bei Minute 1:23 muss eine M6 statt einer M8 sein). In Textform korrigiert man das einfach und gut ist.
- Ich finde den Deutsch/Englisch-Mischmasch extrem störend. Zum einen muss die Dokumentation doppelt gepflegt und synchron gehalten werden, was unnötigen Aufwand bedeutet. Ausländische Projektnutzer düften davon abgeschreckt werden, dass viele wichtige Diskussionen in Deutsch geführt werden (meinen größten Respekt an Bernard!). Deutsche Projektteilnehmer wissen nicht wo/wie sie ihre Fragen stellen sollen und im Deutschen Forum wird ohnehin früher oder später ins Englische gewechselt. Ich weiß, dass einige hier mit der Sprachbarriere zu kämpfen haben, das haben aber die ausländischen Teilnehmer meist auch.
- in Github gibt es einen Bugtracker, den anscheinend keiner moderiert; zudem ist das ardumower-Projekt als HTML gekennzeichnet.
Ich bin als Anfänger in diesem Projekt ganz sicher nicht in der Position Forderungen zu stellen, aber ich (und den Beiträgen im Forum, bei Youtube, etc.) nach zu urteilen bin ich nicht der einzige, der mit der Dokumentationssituation unzufrieden ist. Die Macher des Projektes haben ganz sicher besseres zu tun als immer wieder dieselben Fragen zu beantworten und den Leuten zu erklären, dass sie für einige Fragen erstmal KiCAD in einer dev-Version installieren müssen um bestimmte Details zu erfahren.
Ich helfe gerne mit, die Dokumentation zu verbessern, aber ich habe selbst extrem Mühe alle Infos zusammenzubekommen. Bislang habe ich nicht viel Rückmeldung zu meinen offnen Fragen bekommen. Ich arbeite auch an anderen Projekten mit und habe berufsbedingt auch seit Jahren mit weitaus größeren Kalibern zu tun. Ich kann hier gerne mit meinen Erfahrungen unterstützen.
Ein paar Vorschläge zur Diskussion:
- Alles auf Englisch, dafür nur noch in einfacher Ausführung.
- Eine möglichst klare Trennung der Informationsplattformen:
- - ardumower.de Startseite: Kurze bebilderte Projektvorstellung mit Wegweiser zu allen aktiv gepflegten Informationsquellen
- - ardumower.de Unterseiten: Ich habe das Gefühl, dass die alle vor dem Wiki entstanden sind und nur noch bedingt aktuell sind. Die Seiten sollte als "veraltet" gekennzeichnet werden und/oder ins wiki übertragen werden.
- - das wiki als führende Informationsquelle. Ziel sollte es sein, dass jede Frage, die mehr als einmal gestellt wird im wiki dokumentiert wird und im Forum darauf verwiesen wird.
- - Github als führende Quelle für den aktuellen Entwicklungsstand und die Verwaltung der offenen Bugs. Außerdem fänd ich eine bessere Trennung des Repositories extrem sinnvoll. z.B. je ein Projekt für: Azurit, Raindancer, Sunray, Chassis, PCB 1.3, Perimeter-Sender, Arduremote, Bumperduino, ggf. ardumower.de. Ich denke, das lässt sich ziemlich sauber trennen.
- - Der Bugtracker unter GitHub ist ein extrem wichtiges Werkzeug. Wenn bei mir etwas nicht funktioniert, ist das normalerweise nach der Anleitung im wiki die erste Quelle, die ich konsultiere.
- - Das Forum als Diskussionsplattform für individuelle Belange. Von hier können Nutzer ans wiki (für Anleitungen und Doku), an Github (für Bugs) oder an den Shop verwiesen werden.
Wo ich mir nicht sicher bin ist die Frage, was mit den vielen Blog-ähnlichen Threads passieren soll. Da sind tolle Sachen bei, die aber bei rückläufiger Aktualisierungsrate aus den Augen verschwinden. Vielleicht sollte man diese irgendwo im wiki als Link ins Forum sammeln.
Ich bitte um Entschuldigung, wenn ich hier Dinge vorschlage, die bereits umgesetzt oder diskutiert wurden. Ich habe wie gesagt echt Mühe den aktuellen Stand zu erfassen.
Schöne Grüße,
Kai