Das Wiregate und die Dokumentation - Confluence Server BEREIT

[StefanW]

Ich freue mich zwar sehr über Vorschläge, allerdings hat sich in der Vergangenheit leider niemand gefunden, der ein solches Wiki - egal auf welcher Basis - füllt.

Dokumentation ist aber das Problem aller komplexen Systeme. Einerseits wird es gefordert, andererseits wenn vorhanden oft nicht gelesen. Seien wir doch mal ehrlich, wieviele Prozent der Anwender lesen wirklich die Anleitungen von vorne bis hinten durch. Nach meiner langjährigen Berufspraxis im IT Bereich würde ich weniger als 5% des adressierten Personenkreises schätzen. Denen tut die fehlende Doku weh, die anderen 95% vermissen diese dagegen nicht.

Wie soll man das also finanzieren? weder die 5% noch die 95% werden den gesamten Aufwand tragen / mittragen wollen.

Natürlich könnten wir für ein halbes Jahr einen technischen Redakteur einstellen, der eine komplette Doku für das Wiregate mit allen möglichen Szenarien und anschließbaren Devices vom Temperatursensor bis zur Heizungsanlage erstellt. Aber dann würde uns das geschätzte 50.000 EUR kosten. Nur, wer zahlt? Klar, wäre nur ein 50er für jeden WG-User, aber es werden nur 5% bezahlen wollen. Legen wir es durch höheren VK-Preis auf das WG um? Naja, dann wird es noch teurer und die Leute kopieren sich die Doku und das CommunityGate dazu und fertig.

Verseht ihr unser Dilemma? Ohne massive Hilfe der Community wird es kaum gehen - und die blieb doch am Ende beschränkt. Insbesondere Patrick (swiss) hat sich sehr viel Mühe um die CV-Doku gegeben, und darf auch noch Kritik einstecken dafür.

Wir sollten einen Weg finden, aber wir müssen das zusammen tun, wenn das System günstig bleiben soll.

lg

Stefan

[Hannatz]

Das Wiregate und die Dokumentation

Hi Stefan,

grundsätzlich stimme ich Dir vollkommen zu, vieles an Doku wird kaum gelesen. Aber, Ihr habt doch schon eine Menge an Material produziert (Datenblätter etc), das liegt (aus Kundensicht) aber manchmal etwas verstreut rum und ist bspw. nicht Volltext-indiziert. Wir haben bei uns in der Firma die Erfahrung gemacht, das gerade der "Single Point of Truth" entscheident ist...

Auch für Euch würden sich Vorteile ergeben, so wären Updates der Doku sofort wirksam, es müssten keine PDFs mehr erzeugt werden und revisioniert ist der Kram auch gleich.

Ich für meinen Teil würde hierbei gerne etwas der Community zurückgeben (hab hier viel gelernt) und gerade in diesem Thema bin ich absolut fit!
Wenn also die Entscheidung Pro-Wiki fällt kann ich gerne den Import der vorhandenen Daten übernehmen sowie Confluence administrieren (das Zeugs ist echt gut!!)

Gruß Hannatz

[swiss]

Hallo Stefan

Ja das CV Wiki... Leider habe ich auch nicht immer gleich viel Zeit und Energie daran zu arbeiten aber im grossen ung ganzen denke ich doch, dass es sich lohnt, was für mich dann immer wieder der Antrieb ist daran weiter zu arbeiten (auch wenn die meisten commits von mir sind)

Die Infrastruktur für ein WG Wiki würde ja existieren, wenn man den Webspace des CV wiki mit benutzen würde. Da hätte ich auch die Möglichkeit administrativ einzugreifen. Man könnte da ja ein Testwiki für das WG installieren. Wenn es auf positive Resonanz stösst und sich noch mindestens 2-3 Mitstreiter finden würde, könnte man mal alle Informationen und das gewaltige know-how dass hier im Forum vertielt liegt, zentralisieren.

Ich würde hier auf jeden Fall nach kräften mit helfen

[bluegaspode]

Verseht ihr unser Dilemma? Ohne massive Hilfe der Community wird es kaum gehen - und die blieb doch am Ende beschränkt. Insbesondere Patrick (swiss) hat sich sehr viel Mühe um die CV-Doku gegeben, und darf auch noch Kritik einstecken dafür.

Wir sollten einen Weg finden, aber wir müssen das zusammen tun, wenn das System günstig bleiben soll.

Community Ansatz ist doch in Ordnung und kann ja auch offen als Einleitung im Wiki stehen. Ein paar Personen haben sich ja hier schon gemeldet.
In einer ersten Version müssen glaube ich nichtmal so viele Seiten existieren - ein paar einfache Next-Steps nach der Basiseinrichtung plus passenden Links ergibt mit wenig Aufwand viel Mehrwert.
Mit einer Stunde extra Aufwand (durch die Community) hätte man einen ersten High-Level Überblick über Plugins zusammengetragen ...
Das ganze muss halt organisch wachsen, nen technischen Schreiber anzustellen ist in der Tat dann auch übertrieben.

Ansonsten: wie oft schreibt ihr längere Support-Mails, um irgendwelche Besonderheiten zu erklären? Wenn ihr dazu übergeht, in diesem Moment den gleichen Content in 'nem Knowledge-Base Artikel zu schreiben und in der Support-Mail nur noch darauf zu verlinken entsteht auch eurerseits ohne Mehraufwand ein bißchen Inhalt.
Voraussetzung: ihr müsst selbst dran glauben, dass die Artikel von Benutzern leicht gefunden werden können, da wären wir wieder bei der Plattformfrage.

Seien wir doch mal ehrlich, wieviele Prozent der Anwender lesen wirklich die Anleitungen von vorne bis hinten durch. Nach meiner langjährigen Berufspraxis im IT Bereich würde ich weniger als 5% des adressierten Personenkreises schätzen.

Bist du dir sicher, dass diese Bauchschätzung für die Zielgruppe "Wiregate-Käufer" zutrifft? Ich hätte jetzt eher vermutet, dass sind gerade die, die sich wahnsinnig viel Doku durchlesen, bevor sie die Entscheidung treffen, überhaupt aufs Wiregate zu setzen?
Oder ist Wiregate inzwischen so selbstverständlich, dass die Leute es einfach so kaufen und anschließen (und auch ohne Next Steps ala Visu/Logiken glücklich sind?)

[Micro1972]

Hallo,

ich will auch mal meinen "Senf" dazu geben, weil ich als Anfänger natürlich von einem vernünftigen Wiki profitieren könnte.

Ich fänd es hilfreich, wenn dort auf jeden Fall folgende Fragen beantwortet werden. Außerden müssen die grundlegenden, wichtigen Dinge leicht zu finden sein.

1. Was muss man nach dem Anschließen unbedingt einstellen bzw. parametrieren?
2. Wo und wie können Plugins eingestellt werden und was muss dabei beachtet werden?
3. Welche Visu´s gibt es und wie werden sie installiert?

Vielen Dank von mir für die vielen, hilfreichen Admins und Mitglieder hier im Forum.

LG Mirko

[kisenberg]

wieviele Prozent der Anwender lesen wirklich die Anleitungen von vorne bis hinten durch.

Das ist auch nicht der Anspruch einer guten Anleitung. Denn die ist nicht produkt- sondern handlungsorientiert aufgebaut und daher je nach Bedarf kapitelweise zu lesen.

Natürlich könnten wir für ein halbes Jahr einen technischen Redakteur einstellen, der eine komplette Doku für das Wiregate mit allen möglichen Szenarien und anschließbaren Devices vom Temperatursensor bis zur Heizungsanlage erstellt.

Während meiner Studienzeit als TR wäre das eine interessante Praxissemesterstelle gewesen – Konzeption, Erstellung und Wartbarkeit einer Dokumentation von Produkten in der Gebäudeautomatisierung. Habt ihr in der Nähe keine Hochschule mit dem Studiengang, an dessen schwarzes Brett ihr eure Anforderungen pinnen könntet?

[swiss]

Das mit dem TR hast du etwas aus dem Zusammenhang gerissen...

Stefan schreibt ja, dass sie dies tun könnten ABER das Kostet Geld und niemand will die Kosten dafür tragen.

Ich denke nicht, dass der Student dies Kostenlos macht. Also löst es nicht das Problem der Finanzierung...

[kisenberg]

Ich denke nicht, dass der Student dies Kostenlos macht. Also löst es nicht das Problem der Finanzierung...

Allerdings habe ich als TR in meinem Praxissemster keine 50k EUR verlangt bzw. verlangen dürfen. Schließlich wollte ich etwas lernen. Das ich am Ende trotzdem einen Tausender bekam, war eine freiwillige Geste des Unternehmens.

[swiss]

Hmm.. Gut dies wäre eventuell eine Möglichkeit aber...

Sehr viel Wissen liegt hier im Forum verstreut, dass in dem Zuge auch zentralisiert werden sollte wenn man sich schon die Mühe macht. Und dass zusammen zu tragen ist ein Graus, wenn man nicht schon seit langem hier mit liest und ungefär weiss wo man welche Informationen findet. Wir sprechen hier alleine im Wiregate Supportforum von über 25'500 Beiträgen die man durchkämmen müsste um die hunderte von wissenswerten Zusatzinformationen aus dem Forum zu ziehen und in ein Handbuch zu giessen...

[wuestenfuchs]

...dann wirds höchste Zeit, so etwas aufzubauen, bevor die nächsten 25.000 Einträge kommen und die Infos noch verstreuter liegen als heute.

Wie gesagt, es gibt hier einige Freiwillige, die bereit wären, da mit zu arbeiten. Es müsste halt gut koordiniert werden und die Infrastruktur bereit gestellt werden. Dann wird zwar nicht über Nacht eine Wissensdatenbank in der Endfassung entstehen, aber sie wird mit der Zeit wachsen.

[swiss]

Genau das meine ich ja... Das ganze Wissen aus dem Forum zentralisieren kann höchst wahrscheinlich auch ein Student nicht stemmen. Hier wäre die Community gefragt...

Doch ist es wie so offt... Sehr viele bekunden Interesse, einige helfen sogar anfangs noch mit 2-3 Beiträgen mit und am Ende bleibt die grösste Arbeit auf 1-2 Leuten liegen...

Kenne ich z.B. vom CometVisu Handbuch... Aber ich bin Realist. Es wird mit einem Wiregate Handbuch nicht anders werden. Vor allem weil es mit dem 1mal schreiben nicht getan ist.

So ein Handbuch braucht pflege, da sich auch das Produkt und die Ideen weiter entwikeln. Es wird also sehr warscheinlich genau wie beim CometVisu Handbuch enden... Da stehen 5-6 aktive Entwikler (beim Wiregate und der kreativen Community noch viel mehr) gegenüber EINEM der die vielen Infos und Anpassungen im Handbuch versucht zu pflegen...

Oder wer hier will sich ernsthaft dazu verpflichten SEHR VIEL Freizeit jetzt und in Zukunft für ein solches Handbuch zu opfern? Ohne Bezahlung und geringer Wertschätzung?

Die letzte Frage soll bitte jeder mal gedanklich ganz für sich beantworten...

Für mich ist das Ehrensache, dass mein Versprechen mich um das CV Handbuch zu kümmern nicht nur leere Versprechungen sind. Desshalb kämpfe ich momentan alleine weiter. Auch wenn ich momentan sehr viel anderes zu tun habe und desshalb leider momentan mit dem neuen Handbuch 0.8.0immer noch nicht fertig bin.

-> Aber da ja sonnst keiner hilft, muss ich die Zeit investieren, die mir von meiner "Freizeit" noch bleibt...

Ich verstehe Steffan also sehr gut. Denn DIE Lösung scheint es nicht zu geben...

- Jemanden gegen Bezahlung einstellen der das Handbuch schreibt, will niemand von den Kunden mit höheren Produktpreisen bezahlen.

- Als Community-Projekt wird die Zahl der aktivenund dauerhaften Helfer nicht reichen

Und eine bessere Idee hatte noch niemand... Ich würde für dieses Projekt nach wie vor Hand bieten aber auch ich mache mir Sorgen, dass das Projekt nach kurzem Boom stagniert und am Ende einer (etwa schon wieder ich?) das Projekt am Leben erhalten muss...

[bluegaspode]

Mal anders gefragt :
- stellen wir uns als Worst Case vor es gibt einen kurzen Boom: 5 Leute schreiben 3 Seiten = 15 Seiten. High Level mit Links zu weiterführenden Seiten. Fokus auf 'Next Steps nach der Inbetriebnahme'.
Dann haben alle keine Lust mehr.

Wäre die Situation dann besser, genausogut oder schlechter als vorher?
Welche neuen Risiken hat diese Doku in einem Jahr, wenn keiner mehr dran arbeiten würde (im Vergleich zum Forum mit ähnlich veralteten Infos?).

Was kostet das Abschalten bei missglücktem Versuch? (Im Falle von Confluence: Löschen der schlechten Seiten, PDF Export, Attachment im Forum, Fertig)

Bei der Wertschätzung hätte das Wiregate Team übrigens ein paar Möglichkeiten, die nicht wirklich kosten: Prozente im Shop auch außerhalb der Weihnachtszeit? Teilnahme an Betaprogrammen? Einladung Werksbesichtigung?
Muss ja kein Commitment vorher sein, aber Pflege der Community zahlt sich ja auf alle Fälle aus.

[swiss]

Die Infos im Forum sind immer aktueller als das Handbuch sein kann. Vor allem wenn niemand daran weiter arbeitet. Dann tauchen hier im Forum neue Lösungen auf aber im Handbuch steht dann immer noch alter Käse der vieleicht nicht einmal mehr mit dem neuen Stand funktioniert. Und ob dass besser ist oder nur verwirrt?

Was heute Gültigkeit hat, kann morgen schon wieder anders sein. Vor allem wenn man die vielen Sonderlösungen mit dokumentieren möchte, die nicht von ElabNet sondern der Community kommen.

Wir sprechen hier von durchaus nützlichen Sachen wie Multiroon, DMX, Anbindung von Heizung / Lüftung / PV usw... Dies gehörte wenn dann auch zentral in das Handbuch als Next Step. Denn wie man die Grundkonfiguration macht, steht ja in der Anleitung und den technischen Datenblätter von ElabNet. Nextsteps sind dann häufig Sonderlösungen die einem starken Wnadel unterliegen. Da ist das dokumentieren fast unmöglich denn die paar wehnigen die das Handbuch ernsthaft versuchen zu pflegen müssen überall mitlesen und immer wenn sich etwas geändert hat im Handbuch aktualisieren. Denn erfahrungsgemäss liegt den Entwiklern die Dokumentation nicht sonderlich... Die investieren lieber 10 Stunden in die verbesserung und Erweiterung des Codes als 1 Stunde in die Dokumentation der geänderten/neuen Funktionen. Also muss jemand aussenstehendes dauernd die Augen nach solchen Änderungen offen halten. Und das ist der Grund wesshalb schon nach kurzer Zeit die meisten die vieleicht am Anfang mal mitgemacht haben sich still und heimlich zurückziehen und die anderen die Arbeit machen lassen...

[bluegaspode]

Also wenn man es so negativ sieht, muss man es natürlich noch nichtmal ausprobieren, um zu schauen, was wirklich passiert.
Es kann in die skizzierte Richtung laufen, muss aber nicht.

Meine Erfahrung ist, dass es manchmal nur ganz wenige Sachen braucht, damit es nicht in die von dir aufgezeigte Richtung läuft.

- ne gute Plattform
- einen Kümmerer, der nicht selber schreibt, aber hier und da bei den ausgereiften Lösungen freundlich nachfragt ob der Entwickler das nicht ins Wiki überträgt, weil es da viel besser aufgehoben wäre.
- seitens elabnet ein bisschen Anerkennung (und das fängt schon mit Verlinkung auf den Webseite oder per Wichtig Artikel hier im Forum an)
- optional: quartalsweise ne Verlosung von kleinen Goodies seitens elabnet für die Helfer der letzten Monate, die sie nicht umbringen, um dem ganzen noch ein bisschen mehr Drive zu geben.
- optional: elabnet verlagert selbst Dokumentation, die sie sowieso schreiben (Handbücher + Support Knowledgebase) ins Wiki, damit es noch ein bisschen mehr lebt.

Als Squeezebox noch richtig lebte (in Slimdevices Zeiten), war das ein funktionierendes Konzept.

[Robert_Mini]

Da kann ich bluegaspode nur zustimmen.
Wie so oft fehlt es etwas an Führung.
Von Beginn an eine saubere Struktur (detailliertes Inhaltsverzeichnis), was ist dringlich? Etc.
Zusätzlich ein leichter Zugang zum Wiki.
Das Inhaltsverzeichnis könnte Stefan grob draften und dann hier im Forum detailliert werden.

Klingt alles nach Aufbruchstimmung...

Lg Robert