Codebeispiele vom SDK in Doku verknüpfen
User Story
Als Anbindungsprojekt lese ich mir die Dokumentation zum Verständnis durch und orientiere mich an den vorhandenen Beispielen, wenn diese nicht aktuell sind, habe ich ein Verständnisproblem.
Warum
Die Dokumentation wird nicht schnell genug bearbeitet, sodass die Codebeispiele nicht immer der neusten Anpassung entsprechen. Damit dies nicht mehr der Fall wird und die SDKs weiter in der Aufmerksamkeit der Nutzenden steigen, sollen die Codebeispiele auf SDK .NET & Java SDK & CURL beschränken. Hier gibt es mehrere Möglichkeiten:
- Link zeigt auf SDK Source-Code anstatt händisch eingetippte Codes
- Code für Referenz ermöglicht Information an Dokuteam, wenn etwas passiert --> Script läuft beim SDK-Team und sendet automatischen Merge-Request zum Doku-Team (Präferierte Option)
- Doku verweist auf Tags im SDK und zeigt diese direkt an
Zu beachten ist, ob der Link-Checker eine Fehlermeldung gibt.
Links, Hinweise, Bemerkungen
- Infra kann bei der Automatisierung von GitLab unterstützen
Akzeptanzkriterien
-
Script läuft beim SDK-Team -
Script für Codebeispiele mit Tags -
Script ermöglicht automatisiertes Senden von Merge-Request an das Doku-Team -
* Python wird aktuell nicht als SDK bereitgestellt, alle Beispiele sind auf Java (oder ggf. Shell mit curletc.) umzustellen
- Java-Beispiele sind konsequent als solche zu beschriften (kein Spring), alle Beispiele sind nochmal zu prüfen, ob sie ohne Spring funktionieren
- Sprachlich ist die Anrede auf entweder Leser:Innen oder “Sie” zu vereinheitlichen
-
... -
...
Mögliche Folgeaktivitäten (vom Entwickler zu ergänzen)
-
... -
... -
... -
Definition of Done was checked.
Edited by Laura Elges