docs.freifunk-franken.de - Freifunk Franken Dokumentation

[Markus]

Hallo Steffen,

Ich teile Deine Besorgnis uneingeschränkt.

Hallo lemmi,

Git ist ein Werkzeug für Entwickler.
Meist wird Git nur von Nerds genutzt.
Viele Entwickler haben die Gewohnheit nicht zu dokumentieren (sie können 
den Code ja lesen ;-) ) und sie haben keine Lust, für irgendwelche Laien 
Texte zu schreiben wozu und warum etwas so ist wie es ist, wie es mit 
andern Progs zusammenhängt und wie man etwas anwendet (sie wissen es 
ja). Und sie haben schon gar keine Lust - und oft können sie es gar 
nicht - etwas methodisch-didaktisch so zu erklären und mit Bildern und 
Grafiken zu erläutern, dass es verständlich und nachvollziehbar wird.
Dabei hilft Git leider auch nicht.

Alternativ könnte man die GUI so gestalten, dass Progs intuitiv 
verstehbar und selbsterklärend sind. Die alte Node-FW war ein bisschen 
so. Und Christians plug-and-play-Router sowieso.

Bei Freifunk gibt es Entwickler, die wie Du sich für die Doku einsetzen. 
Danke dafür! Das ist eine Grundvoraussetzung für neue Freifunker, die 
keine Entwickler oder Netzwerktechniker sind.

Du schreibst unten:
- einige nicht die Fähigkeiten haben mit git umzugehen
- Handbuch aufbauen
- Fehler, Missverständnisse und Rechtschreibfehler
- unkontrolliert aus allen Nähten platzt
- Informationen weit verteilt
- ordentliche Organisationsplattform
- Teile mit in der Firmware ausliefern

Das ist alles wichtig für gute Doku :-)

Gleichzeitig ist das unabhängig vom verwendeten System.


Mediawiki wird hundertausendfach eingesetzt. Weltweit.
Auf jedem einzelnen arbeiten oft mehrere Tausend Autoren.

Mediawiki ist dank Wikimedia (Wikipedia, Commons, Wikidata, etc.) und 
einiger Konzerne (die es zur Planung und Dokumentation nutzen und am 
Code mitarbeiten) sehr vielseitig und ausgeklügelt.
Jedes Mediawiki kann automatisch die Daten von Wikipedia, Commons und 
Wikidata nutzen. Es gibt eine gute Schnittstelle zu OpenStreetMap und 
zur dahinter liegenden Geo-Datenbank.

Du kannst auf Deiner Benutzerseite oder in einem speziellen 
Entwurfs-Namensraum beliebig viele Entwürfe anlegen, und alleine oder 
gemeinsam daran arbeiten.

Der VisualEditor ist intuitiv und selbsterklärend:
https://de.wikipedia.org/wiki/Datei:Tutorial_3_Arbeiten_im_Visual_Editor.webm

Wenn Du fertig bist, verschiebst Du den Entwurf in den Artikel-Namensraum.
Dort kann er von allen (oder begrenzt auf einzelne Nutzergruppen) 
weiterbearbeitet werden.

Jede einzelne Bearbeitung ist jederzeit nachvollziehbar (Version).
Jede Bearbeitung kann rückgängig gemacht werden.

Jeder Artikel kann als statisches PDF exportiert werden.

In jedem Artikel kannst Du standardmässig nutzen:
- interne Links (Links zu Wikipedia werden wie interne behandelt)
- externe Links
- Quellen und Anmerkungen (incl. Links)
- Bilder, Grafiken, Audio, Video
   zusätzlich stehen Millionen von Dateien aus Commons zur Verfügung
- ausgefeilte sortierbare Tabellen
- Kategorien in beliebiger Tiefe und Breite
- individuelle Vorlagen, Boxen, Bots, LUA, Statistiken, Plugins, etc.

Zu jedem Artikel gibt es eine Diskussionsseite.
Dort kann man den Inhalt und die Entwicklung planen und diskutieren.
Zu jeder Wikiseite gibt es eine Diskussionsseite, auch für die 
Benutzerseite und für jede Entwurfsseite.

Artikel kann man verschieben, umbenennen, zusammenlegen, Kapitel 
auslagern, etc.

Für die Orga stehen viele Hilfsmittel zur Verfügung.
Und wenn Du willst, kannst Du das ganze Wiki sogar semantisch organisiernen.

Und: Die Doku zu Mediawiki ist hervorragend :-)

Mit herzlichem Gruss,
Markus

PS: wenn jemand natürlich Git oder irgend einen anderen Editor nutzen 
willst für seine Entwürfe, kannst er das selbstverständlich auch tun.
Mache ich manchmal bei grösseren Tabellen z.B. mit Excel.

Zwei Systeme parallel zu pflegen macht nach meiner Erfahrung keinen 
Sinn, denn es würde doppelten Aufwand erfordern.
Und der Aufwand für Konsistenz kaum zu erfüllen.


Am 24.11.2022 um 06:37 schrieb lemmi:
> Moin,
> 
> das Wiki soll ja eben *nicht* ersetzt werden. Mir ist völlig klar, dass 
> einige nicht die Fähigkeiten haben mit git umzugehen. Aber selbst ohne 
> git Kenntnisse kann man sich beteiligen, indem man beispielsweise seine 
> Änderungen in einem Issue oder Mailingliste mitteilt, oder weiterhin das 
> Wiki benutzt um eine Seite zu entwickeln.
> 
> Und zur Aussage, dass im Wiki "Dinge deutlich einfacher zu bearbeiten" 
> sind:
> 
> Ich finde es persönlich unfassbar anstrengend im Wiki zu editieren, 
> Sachen zu finden oder verwalten. Für kompliziertere Themen schreibe ich 
> auch viel lieber mit einem Texteditor meiner Wahl und ohne Onlinezwang.
> 
> Der Plan ist mit https://docs.freifunk-franken.de eine Art Handbuch 
> aufzubauen. Da möchte ich auch einfach, dass mir jemand erst einmal in 
> einem Review auf die Finger schaut, bevor etwas veröffentlicht wird. 
> Fehler, Missverständnisse und zu viele Rechtschreibfehler sollen auf 
> diese Weise nicht so einfach an die breite Öffentlichkeit gelangen. Das 
> Wiki ist nach meinem Empfinden jedenfalls nicht das geeignete Werkzeug 
> dazu.
> 
> Etwas, das ich schon bei anderen Projekten gesehen habe: Es gab zunächst 
> ein Wiki, dass dann irgendwann unkontrolliert aus allen Nähten platzt. 
> Informationen waren weit verteilt und keiner Traut sich Sachen zu 
> korrigieren, weil man schlecht nachvollziehen kann warum und wie etwas 
> hingeschrieben wurde. Das wurde erst besser nach dem es eine ordentliche 
> Organisationsplattform dazu gab.
> 
> Dadurch, dass dabei eine statische Seite entsteht, ist es sogar denkbar 
> teile davon mit in der Firmware auszuliefern, oder lokal dabei zu haben. 
> So kommt man auch ohne Internet an die wichtigsten Informationen, falls 
> gerade an einer Antenne geschraubt und man schnell etwas nachsehen muss.
> 
> Ich hoffe das liefert den vielleicht etwas fehlenden Kontext, warum so 
> eine Plattform für uns sinnvoll sein kann. Ob sich die Sache tatsächlich 
> bewährt, werden wir natürlich erst sehen müssen.
> 
> Grüße,
> 
> lemmi
> 
> On 21.11.22 16:43, Steffen Winkler wrote:
>> Hallo,
>>
>> wir haben doch das Wiki. Da sind Dinge deutlich einfacher zu 
>> bearbeiten. Da braucht man kein git. Je mehr Abhängigkeiten es gibt, 
>> umso mehr Personen werden ausgegrenzt, auch wenn ich selbst git habe, 
>> kann man das nicht verallgemeinern.
>>
>> Grüße von Steffen
>>
>>
>> Am 21.11.2022 um 15:35 schrieb lemmi:
>>> Hallo zusammen,
>>>
>>> ich möchte euch die Freifunk Franken Dokumentation vorstellen:
>>>
>>>     https://docs.freifunk-franken.de
>>>
>>> Die Seite befindet sich gerade inhaltlich im Aufbau. Die technische 
>>> Seite ist aber schon so weit, dass man aktiv unter
>>>
>>>     https://git.freifunk-franken.de/freifunk-franken/docs
>>>
>>> mitarbeiten kann.
>>>
>>> Die Dokumentation soll vor allem ein Platz für komplexere oder 
>>> langlebigere Themen bieten. Mit dem Workflow über git können 
>>> Änderungen im Vorfeld diskutiert und langfristig besser nachverfolgt 
>>> werden.
>>>
>>> Das ganze Projekt versteht sich als Ergänzung für unser Wiki und 
>>> nicht als Ersatz. Sich ständig ändernde Standortsbeschreibungen und 
>>> die Adressverwaltung hat in der Dokumentation eher weniger Platz. Die 
>>> so lange gewünschte *übersichtliche* Einführung in unser Netz 
>>> allerdings schon.
>>>
>>> Also schickt eure Pull Requests, macht Issues auf, lest Korrektur, 
>>> oder antwortet mit weiteren Anregungen auf die Mailingliste. Außerdem 
>>> freue ich mich natürlich, wenn ich das Repository nicht alleine 
>>> verwalten muss.
>>>
>>> Ich versuche beim nächsten Community Treffen 01.12.2022 anwesend zu 
>>> sein um bei Bedarf Hilfestellungen bieten zu können.
>>>
>>> lemmi
>>>