NEUHEIT: Freigegebene Hauptversion V 1.6 ab sofort für alle Modelle des Timberwolf Server verfügbar. Infos: viewtopic.php?f=8&t=2588!

Diskussion zur Verbesserung der Dokumentation

Hier nur wichtige Tipps und Tricks. Schreibrechte nur für freigeschaltete Benutzer

Ersteller
Robert_Mini
Reactions:
Beiträge: 2751
Registriert: So Aug 12, 2018 8:44 am
Hat sich bedankt: 698 Mal
Danksagung erhalten: 1348 Mal

#21

Beitrag von Robert_Mini »

Yves - du sprichst mir aus der Seele.
@StefanW: Wenn du dein Posting #11 und dann #17/#18 liest, mache ich mir im ähnlich Yves Kommentaren auch Sorgen.

Frage Nr.1: Wiki oder Handbuch. Der Übergang ist zwar fließend, aber ich sehe da auch die Crowd-Power im Vordergrund und eure sortierende Hand im Hintergrund (Struktur und Feinkorrektur).
So kann aus einem Wiki sukzessive ein Handbuch werden und manches ein Wiki bleiben zb User Docker oder Custom Logiken.
Auch meine 2ct...

Ein roter Faden zu Beginn ist natürlich gut und wichtig.
Aber ein Staging mit parallel Instanz ist aus meiner Sicht oversized. Ein organisatorisch geregelter Freigabeprozess ist natürlich ok.

Ein Template wär super, ob das dann dynamisch angepasst werden kann, keine Ahnung. @fechter65, Diego: du hast ja Vorlagen in der Logik Doku verwendet: sind das reine Kopiervorlagen?

Robert

PS: Stefan, ich (wir) wollen nicht stressen, einfach mal erst später antworten...
Timberwolf Server 2500 / #117 (VPN offen + reboot nach Rückfrage) / Wiregate-Fan

StefanW
Elaborated Networks
Reactions:
Beiträge: 4998
Registriert: So Aug 12, 2018 9:27 am
Wohnort: Grafing
Hat sich bedankt: 2360 Mal
Danksagung erhalten: 3691 Mal
Kontaktdaten:

#22

Beitrag von StefanW »

Vielen lieben Dank,

es ist nett dass Ihr Euch Sorgen macht.

Wir haben unsere Beweggründe die ich nicht immer in jedem Detail erläutern kann oder möchte - und bitte das zu respektieren.

Es ist wirklich wichtig, dass ich nun an meinem anderen Thema weiterarbeite. Ich melde mich zum Thema Doku dann im neuen privaten Bereich wieder, wenn wir damit weitermachen können.


Wenn ich einen Vorschlag unterbreiten darf:

Wir würden gerne in einem ersten Schritt vor allem den Schatz in der KB heben und in das neue Format bringen. Es wäre total super, wenn man dazu die bestehende KB einmal komplett durchgeht, ob alles noch Up-to-Date ist, auch hinsichtlich Screenshots usw. Es hat sich ja doch eine Menge am Produkt verändert.

Insbesondere würde ich mir auch Wünschen, wenn man den Aufbau etwas strukturell vereinheitlichen könnte, so dass es am Anfang eine Einführung gibt, was das beschriebene Thema ist und welche Voraussetzungen hinsichtlich Wissen und Technik für den beschriebenen Punkt beim Nutzer gegeben sein müssen. Auch gerne eine Angabe was die möglichen Stolpersteine und Fehlermeldungen sind und welche Schritte hilfreich sind um evt. auftretende Probleme oder Fehler einzugrenzen.

Juri hat oben einen guten Vorschlag dazu gemacht.

Das wäre eine wirklich sehr hilfreiche Vorarbeit, die bestehende KB auf einen einheitlichen und aktuellen Stand zu bringen, der die anschließende Übernahme in die Doku sehr erleichtern würde.


lg

Stefan
Zuletzt geändert von StefanW am Di Dez 29, 2020 9:07 am, insgesamt 3-mal geändert.
Stefan Werner
Product Owner für Timberwolf Server, 1-Wire und BlitzART der Elaborated Networks GmbH
Support nur über dieses Forum und in individuellen Fällen über support@wiregate.de.
Bitte KEINE PN Impressum und Datenschutzerklärung oben

FabKNX
Reactions:
Beiträge: 332
Registriert: Mi Aug 15, 2018 7:50 pm
Wohnort: LK Heilbronn
Hat sich bedankt: 438 Mal
Danksagung erhalten: 161 Mal

#23

Beitrag von FabKNX »

just my 2ct:
ich kenn mich mit Confluence überhaupt nicht aus. Aber könnte man das Wiki/Doku nicht in 2 klar visuell getrennte Bereiche aufteilen? Ein Bereich der reviewt ist und von Elabnet komplett freigegeben ist (Aufbau, Wortwahl und Bild). und einen zweiten Bereich in dem die User für User schreiben und ihre Erfahrungen direkt von der Seele schreieben können, dann wenn sie noch am frischesten sind?

PS:
Ich persönlich würde aktuell Doku vor Feature stellen. Der Server kann aktuell schon soooo viel, aber ich weiss sehr oft nicht wie ich anfangen soll. und dann bleibt es halt bei einer Idee.
VG Fabian
TW2500
timberwolf138, VPN offen, Reboot jederzeit
follow me on Instagram: https://www.instagram.com/meinsommer_diy/

StefanW
Elaborated Networks
Reactions:
Beiträge: 4998
Registriert: So Aug 12, 2018 9:27 am
Wohnort: Grafing
Hat sich bedankt: 2360 Mal
Danksagung erhalten: 3691 Mal
Kontaktdaten:

#24

Beitrag von StefanW »

Hallo Fabian,
FabKNX hat geschrieben: Di Dez 29, 2020 9:00 amich kenn mich mit Confluence überhaupt nicht aus. Aber könnte man das Wiki/Doku nicht in 2 klar visuell getrennte Bereiche aufteilen?
Darüber denken wir nach.

Es macht durchaus Sinn zwischen offizieller Doku und User-für-User-Wiki zu unterscheiden.

FabKNX hat geschrieben: Di Dez 29, 2020 9:00 amDer Server kann aktuell schon soooo viel,
da wird noch viel mehr kommen

FabKNX hat geschrieben: Di Dez 29, 2020 9:00 amaber ich weiss sehr oft nicht wie ich anfangen soll. und dann bleibt es halt bei einer Idee.
Bitte gibt uns Beispiele, was Deine Vorhaben gewesen wäre und Du nicht wusstest wo Du Dir mehr Hilfe gewünscht hättest.
Stefan Werner
Product Owner für Timberwolf Server, 1-Wire und BlitzART der Elaborated Networks GmbH
Support nur über dieses Forum und in individuellen Fällen über support@wiregate.de.
Bitte KEINE PN Impressum und Datenschutzerklärung oben
Antworten

Zurück zu „Essentials - Wichtige Tipps & Tricks“