Dokumentationsuppdrag ht -22
Input
Kika på Dokumentationsregler
Leverans
Kontinuerlig leverans - med ett antal kontrollpunkter under hösten (så se till så att det blir gjort - det gör ni via Jira förstås ).
Ansvariga för helheten
@ola.enebro (Unlicensed) - Team Dynasty
@Jakob Melander - Team Unmasked
@Mikael Nordlander (Unlicensed) - Team Evolution/Team Monster
@Markus Flyborg (Unlicensed) - Team Mothership/Mitt Sundsvall
@Hanna Jonzon (Unlicensed) - Team Revenge
Att göra
API-dokumentation
Se till så att all API-dokumentation följer våra riktlinjer på Dokumentationsregler - förtydligande:
Samtliga APIer som skall användas av våra intressenter (kanaler t ex - gäller alltså inte stöd-APIer vi endast använder internt inom fabriken) som ligger i produktion skall exponeras öppen på Internet.
Se till att senaste mallen för API-dokumentation används (inklusive swagger-UI mm) och att all information finns ifyllt (kika på andra APIer som ligger öppet för exempel).
Hur man går till väga för att exponera ett API i vår öppna katalog, samtidigt som det också återfinns i vår interna katalog beskrivs här: API-dokumentation både internt och externt - hur gör man?
Ansvariga
@ola.enebro (Unlicensed) - Team Dynasty
@Jakob Melander - Team Unmasked
@Mikael Nordlander (Unlicensed) - Team Evolution/Team Monster
@Markus Flyborg (Unlicensed) - Team Mothership
Schemalagda jobb
Säkra så att samtliga schemalagda jobb är dokumenterade på en adekvat nivå.
Ansvariga (har ni inget så går det fort, men kolla)
@ola.enebro (Unlicensed) - Team Dynasty
@Jakob Melander - Team Unmasked
@Mikael Nordlander (Unlicensed) - Team Evolution/Team Monster
@Markus Flyborg (Unlicensed) - Team Mothership
Kanaldokumentation
Vi behöver få koll på vad våra kanaler integrerar med. Producera lösningsbilder som visar detta för respektive kanalapplikation (OpenE, sundsvall.se (Sitevision), företagscenter, GMS, Mitt Sundsvall m fl).
Skapa en ny sida (“Kanaler” kanske räcker bra som namn) där alla lösningsbeskrivningar samlas ihop direkt under Sundsvalls kommun .
Ansvariga
@Markus Flyborg (Unlicensed) - Mitt Sundsvall
@Hanna Jonzon (Unlicensed) - Team Revenge
Uppdragsdokumentation → rätt plats
Gå kontinuerligt igenom uppdragen under Uppdrag/projekt .
Finns det inom ett uppdrag lösningsbeskrivningar på produktions-satta lösningar, flytta dessa till korrekt ställe (till Lösningsbeskrivningar t ex).
Ansvariga
@ola.enebro (Unlicensed) - Team Dynasty
@Jakob Melander - Team Unmasked
@Mikael Nordlander (Unlicensed) - Team Evolution/Team Monster
@Markus Flyborg (Unlicensed) - Team Mothership/Mitt Sundsvall
@Hanna Jonzon (Unlicensed) - Team Revenge
utveckling.sundsvall.se
Vi behöver hjälpas åt att se till så att dokumentationen på utveckling.sundsvall.se är korrekt, och att vi inte har en massa information dubbeldokumenterad på både http://utveckling.sundsvall.se och Confluence.
Dokumentation på Confluence som passar bäst på http://utveckling.sundsvall.se skall flyttas dit (alltså inte mer teknisk dokumentation som vi i så fall exponerar externt via API Infrastruktur Sundsvalls Kommun ), och länkas till från Confluence (exempel: API-relaterade krav vid upphandling ) - hjälp till att identifiera sådant.
Hjälp även till med att komma med input till tidslinjen på Koncerngemensamma komponenter .
Ansvariga
@ola.enebro (Unlicensed) - Team Dynasty
@Jakob Melander - Team Unmasked
@Mikael Nordlander (Unlicensed) - Team Evolution/Team Monster
@Markus Flyborg (Unlicensed) - Team Mothership/Mitt Sundsvall
@Hanna Jonzon (Unlicensed) - Team Revenge