API-dokumentation

API-dokumentation skall livscykel-hanteras i vår API-katalog;

• Under design och utveckling dokumenterar vi här (i vår interna API-katalog) API-katalog .

• När ett API som skall användas av våra intressenter (gäller alltså inte stöd-APIer vi använder internt fabriken) ligger i produktion skall de exponeras öppen på Internet, här: API-katalog .
  Hur detta går till kan ni läsa om här: API-dokumentation både internt och externt - hur gör man?

Schemalagda jobb

Våra funktioner som körs som schemalagda jobb skall livscykel-hanteras på Schemalagda jobb

Lösningsbeskrivningar och Lösningsmönster

Lösningsbeskrivningar skall dokumenteras och livscykel-hanteras oberoende av team och projekt (även om de så klart kan tas fram inom ramen för ett projekt av ett eller flera team), och samlas under Lösningsbeskrivningar .

Lösningsbeskrivningar som har karaktären av ett generiskt lösningsmönster skall dokumenteras externt - hur man ser till att dokumentationen är tillgänglig även internt sker på samma sätt som för APIer (se ovan).

Enterprise-arkitekturrelaterad dokumentation (informationsmodeller, verksamhetsprocesser samt applikationsarkitektur) dokumenteras i Sparx.

Regler och riktlinjer

Personuppgifter som inte får behandlas

Vi skall inte hantera några känsliga personuppgifter eller större mängder av personuppgifter i form av register inom varken Confluence eller Jira.

Personuppgifter som får behandlas

Nedan beskrivs de personuppgifter som kommer eller kan komma att behandlas inom Confluence och/eller Jira.

Användaruppgifter på utvecklare och projektmedlemmar i utvecklingsprojekt

Syftet med denna behandling är att möjliggöra inloggning för enskilda utvecklare och projektdeltagare för åtkomst till funktion och dokumentation samt för att delta i utvecklingen av våra lösningar. Även för samverkan i form av att man tilldelas ärenden eller omnämns i minnesanteckningar kan namn på användare i lösningen förekomma.

De uppgifter som kommer att behandlas är:

• Användarnamn

• E-post

• Telefon

• Förnamn

• Efternamn

• Roll

Kontaktuppgifter till verksamhetsspecialister

När man genomför utveckling kommer man behöva dokumentera kontaktuppgifter till verksamhetsspecialister som kan svara på verksamhetsspecifika frågor och bistå med kravställning. Generellt finns en rutin om att använda sig av roll när man hänvisar till personer men det kan komma fall där man behöver skriva in kontaktperson och dennes kontaktuppgifter.

De uppgifter som kan komma att behandlas är:

• Förnamn

• Efternamn

• E-post

• Telefon

• Roll

Teknisk data

För varje teknisk dokumentation behöver det ske en bedömning om dess känslighetsgrad, beroende på nivån och djup av dokumentation samt vilken verksamhetsprocess den stöttar samt vilken information som hanteras inom den måste tas i beaktning. Generellt är det dock ingen fara med dokumentation på arkitekturnivå, men inom vissa segment (t ex nationellt skyddsvärda objekt) kan det även vara känsligt med detta.

Teknisk dokumentation som inte får finnas i Confluence/Jira

• Lösenord

• Kopior av data från verksamhet, t ex loggar eller databas-dumpar som innehåller verklig produktionsdata och/eller personuppgifter

Undvik även

• Information om brandväggsöppningar och nätkonfigurationer