Documentatie en selfservice-workflows
Maak Terraform-projecten toegankelijk voor het hele team met gegenereerde documentatie, README-conventies en pre-commit-automatisering die de kwaliteit hoog houdt.
Documentatie en selfservice-workflows is een gratis DevOps-bootcamp-les op CoddyKit. Dit is les 4 van 4. Je kunt 3 lessen uit dit leerpad gratis volledig lezen — daarna ontgrendelt CoddyKit PRO alle lessen, plus praktische oefeningen met een ingebouwde code-editor en een AI-tutor die 24/7 beschikbaar is. Deze les maakt deel uit van het leertraject DevOps-bootcamp. Je voortgang wordt gesynchroniseerd op het web en in de CoddyKit-app. De cursus DevOps-bootcamp bevat in totaal 4 lessen.
Waarom documentatie belangrijk is
Goede samenwerking draait om meer dan nette code. Teamleden moeten begrijpen wat een module doet, welke invoer deze verwacht en hoe ze deze veilig uitvoeren. Actuele documentatie verandert een repository in een hulpmiddel waarmee iedereen zelfstandig aan de slag kan.
De README als voordeur
Elke Terraform-repository hoort te beginnen met een README over het doel, de vereisten, een gebruiksvoorbeeld en invoer- en uitvoerwaarden. Dit is het eerste wat een nieuwe bijdrager leest.
Documentatie automatisch genereren
De tool terraform-docs scant je variabelen en uitvoerwaarden en maakt een Markdown-tabel, zodat de documentatie nooit van de code afwijkt.
terraform-docs markdown table . > README.mdDocumentatie in een README invoegen
Gebruik markeringsopmerkingen, zodat terraform-docs slechts één sectie bijwerkt en je zelfgeschreven inleiding behouden blijft.
<!-- BEGIN_TF_DOCS -->
<!-- END_TF_DOCS -->Beschrijvingen bepalen de kwaliteit van de documentatie
Gegenereerde documentatie is slechts zo goed als de velden description. Behandel ze als tekst die gebruikers te zien krijgen.
variable "instance_type" {
type = string
description = "EC2 size, e.g. t3.micro for dev or m5.large for prod"
default = "t3.micro"
}Pre-commit-hooks
Een pre-commit-framework voert vóór elke commit controles uit en vangt problemen op voordat ze de codebeoordeling bereiken. Je configureert het met een YAML-bestand.
repos:
- repo: https://github.com/antonbabenko/pre-commit-terraform
hooks:
- id: terraform_fmt
- id: terraform_validate
- id: terraform_docsDe hooks installeren
Voer de installatieopdracht één keer per kloon uit, zodat de hooks automatisch bij elke commit worden geactiveerd.
pre-commit installOpmaak en linting afdwingen
Combineer terraform fmt met een linter zoals tflint om provider-specifieke fouten op te sporen, zoals ongeldige instantietypen.
tflint --recursiveEen CONTRIBUTING-handleiding
Documenteer de workflow van je team in een CONTRIBUTING-bestand: naamgeving van branches, hoe je plan uitvoert en wie toepassingen goedkeurt. Zo hoeven nieuwkomers niets te raden.
Architectuurbesluiten
ADR's leggen vast waarom een keuze is gemaakt (bijvoorbeeld waarom je een externe backend hebt gekozen). Door ze in de repository op te slaan, blijft de context behouden lang nadat de oorspronkelijke auteur is vertrokken.
docs/adr/0001-use-s3-backend.mdZelfbediening via voorbeelden
Met een map examples/ met uitvoerbare miniconfiguraties kunnen gebruikers een werkende configuratie kopiëren in plaats van de invoer terug te moeten reconstrueren. De map dient ook als materiaal voor integratietests.
examples/
minimal/main.tf
complete/main.tfKorte controle
Test je kennis van documentatietools.
Samenvatting: repositories voor zelfbediening
Je hebt geleerd hoe je samenwerking soepel maakt:
- Een sterke README en CONTRIBUTING-handleiding.
- terraform-docs voor automatisch gegenereerde tabellen met invoer en uitvoer.
- pre-commit-hooks die fmt, validate en lint uitvoeren.
- ADR's en voorbeelden die context en gebruik vastleggen.
Leer DevOps-bootcamp met een AI-tutor — gratis
Schrijf echte code en voer die uit in je browser, krijg direct hulp van een AI-tutor die 24/7 beschikbaar is en ga verder waar je gebleven bent op het web of in de app.
- Cursussen
- 142
- Lessen
- 568
Veelgestelde vragen
Is de les “Documentatie en selfservice-workflows” gratis?
Ja — je kunt hier op het web alle 3 lessen van het leerpad DevOps-bootcamp, waaronder “Documentatie en selfservice-workflows”, gratis volledig lezen. Daarna ontgrendelt CoddyKit PRO alle lessen, plus interactieve oefeningen met een ingebouwde code-editor en een AI-tutor die 24/7 beschikbaar is. De cursus DevOps-bootcamp bevat in totaal 4 lessen.
Wat leer ik in “Documentatie en selfservice-workflows”?
Maak Terraform-projecten toegankelijk voor het hele team met gegenereerde documentatie, README-conventies en pre-commit-automatisering die de kwaliteit hoog houdt. Je oefent met DevOps-bootcamp door code rechtstreeks in de browser uit te voeren. Een AI-begeleider die 24/7 beschikbaar is beantwoordt je vragen terwijl je de les doorwerkt.
Heb ik ervaring nodig om met DevOps-bootcamp te beginnen?
Ervaring vooraf is niet nodig. DevOps-bootcamp op CoddyKit is opgebouwd voor beginners tot gevorderden, zodat je hier of bij het begin kunt starten en in je eigen tempo kunt leren. Dit is les 4 van 4.
Hoe lang duurt de les “Documentatie en selfservice-workflows”?
De meeste lessen van CoddyKit duren ongeveer 5–10 minuten. Elke les is kort en interactief, zodat je gestaag vooruitgaat en op het web en in de app precies verdergaat waar je was gebleven.
Kan ik code schrijven en uitvoeren in deze les over DevOps-bootcamp?
Ja. Elke les over DevOps-bootcamp bevat een ingebouwde code-editor, zodat je rechtstreeks in je browser echte code kunt schrijven en uitvoeren en direct feedback van AI krijgt — lokale installatie is niet nodig.
Alle lessen in deze cursus
- Codestructuur en naamgevingsconventies
- Versiebeheer met Git
- Samenwerking en workflows voor teams
- Documentatie en selfservice-workflows