@rammi22 schrieb:
[@Moritz Naczenski](http://forum.shopware.com/profile/14574/Moritz Naczenski „Moritz Naczenski“) um den möglichen Eindruck eines Frust-Threads entgegenzutreten, wie schaut den ein konkreter Plan zu beispielsweise der Dokumentation aus? Was wird da gemacht? Wie sind die geplanten Schritte? Gibt es was Konkretes?
Ich denke diese Fragen sind verständlich sachlich und mit konstruktiver Intuition.
Grundsätzlich würde ich hier zwischen User-Dokumentation und Entwickler-Dokumentation unterscheiden. An beiden Projekten wird stetig gearbeitet und auf Basis von Tickets werden Verbesserungen umgesetzt.
Enduser-Dokumentation:
- Tickets die über den Issuetracker eingestellt werden
- Feedback aus der Bewertungsfunktion der Doku
- Feedback aus der Umfrage der Doku
- offizielle Supporttickets
- Neue Funktionen und Inhalte aus dem Entwicklungsprozess
Das ist ein laufender Prozess, es gibt mehrere Mitarbeiter, die sich Vollzeit damit beschäftigen die Dokumentation für Shopbetreiber zu schreiben und zu aktualisieren. Hier geht es vor allem darum externes Feedback einfließen zu lassen. Wir haben dieses Jahr bisher 20.000 Supportanfragen die jeweils ein Doku-Ticket erzeugen, wenn etwas nicht dokumentiert wurde.
Developer Dokumentation:
- Tickets die über den Issuetracker eingestellt werden
- Feedback aus der Bewertungsfunktion der Doku
- Feedback aus der Umfrage der Doku
- Neue Funktionen und Inhalte aus dem Entwicklungsprozess
- Informationen aus dem Slack-Thread (Post in Announcements)
- Feedback von Github
- offizielle Supporttickets
Auch das ist ein laufender Prozess, der ganz regulär im Entwicklungsprozess mitläuft.
Grundsätzlich hat die Dokumentation ein Problem: Bestehende Inhalte sind nicht optimal dokumentiert. Dies verbessert man natürlich nicht, indem man Dokumentation für neue Dinge sicherstellt. Wir haben intern einige Prozesse umgestellt, die sicherstellen, dass neue Vorgänge in der Software immer ausreichend dokumentiert werden. Dies hilft natürlich nicht bei Dingen die bereits fehlen oder auch nicht im Punkt Tutorials. Hier sammeln wir Themen aus der Community und setzen diese um. Eines dieser Themen ist bspw. die Überarbeitung des Changelogs: https://github.com/shopware/platform/tree/master/changelog
Also konkret Dinge die in jüngster Zeit dazu gekommen sind:
- Sicherstellen, dass neue Inhalte direkt mit Release dokumentiert sind
- Neue Changelog Struktur
- Sammlung von Themen die in der bestehenden Dokumentation optimiert werden müssen
- Auswertung von Bewertungsfunktion und Umfrage
Diese Daten werden dann in Tickets gegossen und von der Entwicklung umgesetzt. Hierzu wird es dann ein entsprechendes Epic auf der Roadmap geben, welches diese Anpassungen einplant. Jeder der schreibt „Die Dokumentation ist fehlerhaft“ oder „Die Dokumentation ist unvollständig“ -> Diese Aussage bringt mir und uns rein garnichts. Wenn es ein konkretes Thema gibt, stellt dafür ein Ticket ein und es wird eingeplant und umgesetzt. Und ein Ticket ist dazu wirklich wichtig, weil es sonst untergeht und nicht umgesetzt wird.
Es wird also definitiv aktiv an der Dokumentation gearbeitet, es wird nur niemals einen Knopf geben, der umgelegt wird und alles ist gut. Das ist ein iterativer Prozess der stetig erfolgt und auf Basis des Userfeedbacks die Dokumentation verbessert. Wenn du also einen Teil dazu beitragen willst, erstelle Tickets, wenn dir etwas in der Dokumentation fehlt: issues.shopware.com.