User Documentation Struktur
Die aktuellen fünf Anleitungen wurden ursprünglich als Beiträge im Joomla Community Magazine veröffentlicht, geschrieben von Brian Teeman und von ihm für diese Dokumentation eingereicht.
Wir arbeiten noch an den Menüstrukturen, um Anleitungen, Tutorials, Erklärungen usw. so anzuordnen, dass sie dynamisch gefiltert und sortiert werden können. Für den Moment werden diese Anleitungen jedoch nur in zufälliger Reihenfolge veröffentlicht.
Über Anleitungen
Aus https://diataxis.fr/how-to-guides/:
Anleitungen sind Wegweiser, die den Leser durch ein Problem oder zu einem Ergebnis führen. Anleitungen sind zielorientiert.
Eine Anleitung hilft dem Benutzer, etwas korrekt und sicher zu erledigen; sie leitet die Handlung des Benutzers.
Es geht dabei um Arbeit – das Navigieren von einer Seite zur anderen eines realen Problemfeldes.
Beispiele könnten sein: wie man das Radararray kalibriert; wie man Fixtures in pytest verwendet; wie man Wiederverbindungs-Backoff-Richtlinien konfiguriert. Andererseits ist wie man eine Webanwendung erstellt keine solche – das adressiert kein bestimmtes Ziel oder Problem, sondern ist ein weitläufig offener Kompetenzbereich.
Anleitungen sind nicht nur deshalb wichtig, weil Benutzer in der Lage sein müssen, Dinge zu erledigen: Die Liste der Anleitungen in Ihrer Dokumentation hilft dabei, ein Bild davon zu vermitteln, was Ihr Produkt tatsächlich leisten kann. Eine umfangreiche Liste von Anleitungen ist ein ermutigender Hinweis auf die Fähigkeiten eines Produkts.