Training Software, Architectuur en Applicaties Documenteren

Applicaties worden eigenlijk alleen maar groter en complexer. Ook neemt het aantal afhankelijkheden toe. Daarom is het belangrijk om je applicaties goed te documenteren. Het gaat dan natuurlijk om code, maar ook om de architectuur en bijvoorbeeld configuratie in de cloud. Tijdens de training leer hoe je software op een gestructureerde manier documenteert.

Algemene omschrijving

Documentatie is in de praktijk nogal eens een ondergeschoven kindje. Als teams groter worden, of de complexiteit en omvang van software toeneemt, wordt duidelijk dat documenteren voor de toekomst van levensbelang is.

Tijdens deze training leggen we het accent op het volledig documenteren van je applicatie. Dat beperkt zich dus niet tot code. Een applicatie is in de regel afhankelijk van het platform (cloud- of hostingplatform), gebruikte middleware en bijvoorbeeld eventuele externe diensten en integraties.

Bedrijfstraining Software, Architectuur en Applicaties Documenteren

Wil je met je met een heel team leren je software, architectuur en code te documenteren? In een bedrijfstraining kunnen wij de training volledig op maat voor jouw organisatie verzorgen, voor jou en wellicht een groep van je collega's.

Tijdens een bedrijfstraining kun je bijvoorbeeld jouw praktijk als uitgangspunt nemen. Hoe documenteren jullie momenteel je software? Hoe zou je dat kunnen optimaliseren? Hoe past dat in jullie manier van werken? Een bedrijfstraining sluit altijd perfect aan bij wat jij en je team moet beheersen om perfect te kunnen documenteren.

Programma

Tijdens de Training Software, Architectuur en Applicaties Documenteren komen in basis onderstaande onderwerpen aan bod. Afhankelijk van ontwikkelingen op het vakgebied, kan de feitelijke trainingsinhoud hier echter van afwijken. Bel ons gerust voor meer informatie over de actuele inhoud.

• Documenteren
• • Wat is documenteren?
  • Documenteren als uitgangspunt van software
  • Wat betekent documenteren in software?
  • Welke documentatievormen zijn in software gebruikelijk?
  • • Tekst
    • Stroomdiagrammen
• Code
• • Beschrijving code zelf
  • Code schrijven in de vorm van processen
  • Naamgeving in code
  • Code schrijven als afspiegeling van business processen
  • Generieke beschrijving opbouw software en code
  • Code in relatie tot de rest van het platform
  • Bijbehorende diagrammen
  • Opbouw commentaar in code zelf
  • Vastleggen interne afspraken over code gebruik (bijv. naamgeving, consistentie, etc.)
  • Code beheren en commentaar (bijv Gitlab)
  • Versiebeheer en versiebeschrijving
• Software Architectuur Documenteren
• • Design als basis
  • Documenteren software architectuur
  • Diagram gebruikte software
  • Beschrijvingen bij diagram
  • Specifieke configuratie elementen beschrijven (bijv. API's)
  • Configuratiebestanden toevoegen
• Beheer en onderhoud
• • Beheer van code
  • Versiebeheer
  • Beheer van documentatie
  • Beheer diagrammen, workflow, user stories
  • Verantwoordelijkheden
• Gebruikers en processen
• • User stories schrijven
  • Processen beschrijven
  • Relatie user story en gebruikte code/platform/architectuur
  • Relevante API's / microservices / code
• Platform: Hosting, Cloud en clouddiensten
• • Beschrijving Cloud en clouddiensten
  • Architectuur diagram
  • Relevante gegevens (inloggegevens, api keys etc)
  • Beschrijving security
• Toepassen op eigen software