Reorganisation of the Hubzilla Help - Neuaufbau der Hubzilla Hilfe
I have started working on the German Help for Hubzilla. At the moment I have already translated and partly rewritten some articles/pages. In general, however, I'm wondering if it's worth just translating the 'original' (English) help (with some necessary complete rewrites of articles).
The structure dates back to the 'old days' and was certainly not originally designed to meet the needs of users and admins. It's all a bit chaotic and gives the impression of being 'thrown together'.
In my opinion, the Help Centre really needs to be restructured from the ground up. It should be organised in such a way that a complete novice can understand how things work, but also in such a way that advanced users can find things that are important to them and can be helped.
Restructuring does not mean rewriting everything. Much of what is already there just needs to be adapted, organised differently and perhaps rewritten in a more comprehensible way.
I think the basic structure makes sense... i.e. the division into User Manual, Administrator Manual, Developer Manual and Tutorials. I don't see any need to change this.
The current categorisation below is not wrong either, but could be improved. I always try to look at it from the perspective of a user who hasn't worked with Hubzilla for a long time or much, or who comes from another Fediverse platform. This would require, for example, a reorganisation of the first chapters of the user manual... and some additional points.
I would start now to come up with a categorisation / structure and then present it here... then ask for suggestions for changes, improvements, suggestions, additions.
Once the basic structure is in place, I would start writing or rewriting the individual articles (if they exist in the existing documentation and are usable). I am comfortable doing this in both German (my native language) and English. As far as the English texts are concerned, however, I'd urge people who speak English better than I do to critically review them (which shouldn't be hard).
So, and now to this post here: comment, express wishes / change requests, make suggestions.
And if the idea is no good, please let me know right away... then I can skip the work and focus on translating the old help again.
Ich habe begonnen, mich um die deutschsprachige Hilfe für Hubzilla zu kümmern. Derzeit habe ich schon einige Artikel / Seiten übersetzt und zum Teil neu geschrieben. Generel aber frage ich mich, ob es sich lohnt, die "originale" (englischsprachige) Hilfe einfach zu übersetzen (mit teilweise notwendigen kompletten Neufassungen von Artikeln).
Die Struktur stammt ja aus wirklich "alten Zeiten" und war anfangs mit Sicherheit nicht wirklich an den Bedürfnissen der Nutzer und Admins orientiert. Es ist alle ein wenig chaotisch und erweckt den Eindruck "zusammengewürfelt" zu sein.
Nach meiner Auffassung müsste die Hilfe wirklich von Grund auf neu strukturiert werden. Sie sollte sich so verhalten, dass auch komplette Neulinge verstehen, wie was funktioniert, aber auch so, dass fortgeschrittene Nutzer dort für sie wichtige Dinge finden und ihnen geholfen werden kann.
Eine Neustrukturierung bedeutet nicht gleichzeitig, das wirklich alles neu geschrieben werden müsste. Vieles, was vorhanden ist, muss auch nur angepasst, anders unterteilt und vielleicht ein wenig verständlicher umgeschrieben werden.
Die Grundstruktur halte ich für sinnvoll... also die Einteilung in Benutzerhandbuch, Administartorenhandbuch, Entwicklerhandbuch und Tutorials. Da sehe ich keinerlei Änderungsbedarf.
Die derzeit darunter liegende Einteilung ist jetzt auch nich falsch, könnte aber Verbesserungen gebrauchen. Ich versuche es immer auch aus der Perspektive eines Nutzers zu betrachten, der bisher noch nicht lange oder viel mit Hubzilla gearbeitet hat oder der von einer anderen Fediverse-Plattform kommt. Das würde eine Umstrukturierung z.B. der ersten Kapitel des Benutzerhandbuchs erforderlich machen... und einige zusätzliche Punkte.
Ich würde jetzt damit beginnen, mir eine Einteilung / Struktur zu überlegen und hier dann vorzustellen... dann mit der Bitte um Änderungsvorschläge, Verbesserungen, Anregungen, Ergänzungen.
Sobald die grundlegende Struktur steht, würde ich dann beginnen, die einzelnen Artikel zu schreiben bzw. umzuformulieren (sofern sie in der bestehenden Dokumentation existieren und nutzbar sind). Ich mute es mir zu, dies sowohl in Deutsch (meine Muttersprache) als auch in Englisch zu tun. Was die englischprachigen Texte betrifft, bitte ich aber dringend um kritische Kontrolle durch Helfer, die im Englisch besser sind als ich (was keine Kunst sein dürfte).
So, und nun auch zu diesem Beitrag hier: kommentieren, Wünsche / Änderungswünsche äußern, Anregungen geben.
Und falls die Idee nicht taugt, dann bitte auch gleich mitteilen... dann kann ich mir die Arbeit sparen und mich wieder auf das Übersetzen der alten Hilfe konzentrieren.
Der Pepe (Hubzilla) ⁂ ⚝ wrote the following post Wed, 11 Sep 2024 07:30:34 -0500
