Formelle Gesichtspunkte zur Doku

[Feuersturm]

In der aktuellen Doku gibt es schon einen Styleguide welcher ebenfalls hilfreich ist: https://www.iobroker.net/#de/documentation/community/styleguidedoc.md

Dort ist ebenfalls eine Hilfestellung zu Markdown enthalten: https://www.iobroker.net/#de/documentation/community/docmarkdown.md

[Homoran]

@feuersturm sagte in Formelle Gesichtspunkte zur Doku:

welcher ebenfalls hilfreich ist

Ja, einiges davon muss selbst ich mehrfach lesen um halbwegs zu galuben ich hätte es verstanden, aber im allgemeinen passt es.

Kannst du mir sagen wo ich .editorconfig finde?

[Feuersturm]

@homoran sagte in Formelle Gesichtspunkte zur Doku:

Kannst du mir sagen wo ich .editorconfig finde?

Ich hab keine editorconfig für die Doku gefunden.

[AlCalzone]

@homoran sagte in Formelle Gesichtspunkte zur Doku:

Kannst du mir sagen wo ich .editorconfig finde?

Die müsste sich eigentlich im entsprechenden Repository finden... eigentlich.

[OliverIO]

@homoran

damit man nicht alles neu erfinden muss
https://opensource.com/article/20/3/documentation
https://medium.com/capital-one-tech/art-of-open-source-documentation-5b8b3f5b0ab

[Jey Cee]

Hier mal noch ein Vorschlag:
Aktuell wird nur das Datum hinterlegt wann die Seite das letzte mal Aktualisiert wurde.
Bei Themen die Versionsabhängig sind sollten die Versionen gut Sichtbar angegeben werden. Damit man Einordnen kann ob die Informationen der Seite für einen selbst zutreffend sind.

In der Form "Gültig für folgende Versionen" oder "Getestet mit folgenden Versionen"

[Homoran]

@jey-cee Auch wenn es hier wieder um Formalitäten geht, die Beamtendeutschlands würdig sind, so hatte ich vor Jahren so etwas vorgeschlagen.
Damals gab es noch einen "Steckbrief" als Header in den Doku-Seiten.

Auch der Ersteller sollte IMHO irgendwo drinstehen. Aber was, wenn später nur an einzelenen Stellen Änderungen durch jemand anderes durchgeführt werden.

Im Moment sollten wir zusehen, dass Content eingepflegt wird.
Jeder -auch du- kann dann PullRequests mit einer konstruktiven Änderung einbringen

Die Hürden sollten im Moment so niedrig wie möglich gehalten, und nur auf funtionsrelevante Dinge beschränkt bleiben, sonst wird es noch ewig Platzhalter und fehlende Inhalte geben

[crunchip]

ich wollte es mal anmerken und hoffe es passt hier rein

es war ja schon mal Gesprächsstoff das die Verlinkung innerhalb der Doku nicht funktioniert wie es soll

Beispiel aus der Seite https://www.iobroker.net/#de/documentation/install/nodejs.md

funktioniert nicht

## Anleitung für Windows 
Node.js wird durch die Ausführung des [Windows Installers](./windows.md) aktualisiert.

funktioniert

#### 3 - Adapter aktualisieren
- Anleitung dazu findet man unter [Adapter verwalten](https://www.iobroker.net/#de/documentation/install/updatenode.md )

und da es auf vielen Seiten wie in Variante 1 verlinkt ist, funktionieren die Links nicht

[Homoran]

@crunchip sagte in Formelle Gesichtspunkte zur Doku:

Beispiel aus der Seite

hmm, da finde ich die Beispiele nicht

alle Links funktionieren

[crunchip]

@homoran war der falsche link, habs oben korrigiert

[crunchip]

Soweit ich mich erinnern kann, sollte eigentlich wie in Variante 1 geschrieben werden, jedoch liegt das an der Übersetzung in mehreren Sprachen und funktioniert so nicht, daher hatte ich beim Schreiben Variante 2 verwendet.