Kategori:Dokumentationsformer

I disse kapitler er der beskrevet hvordan man typisk vil kunne dokumentere Arduino projekter. I kapitlerne Softwareudvikling er der beskrevet mere generelt hvordan man kan håndtere og dokumentere processen med at udvikle software helt generelt, og ikke bare til Arduinolignende miljøer.

Systemdokumentation

I alle de tilfælde vi tager udgangspunkt i, så er der anvendt hardware (opbygget primært omkring Arduino UNO), derfor giver det god mening at der skal gives et overblik over denne hardware og hvordan det hænger sammen.

Dokumentation med Kode og Flowchart

Når man anvender programmering i et projekt, så skal det dokumenteres hvordan koden virker. En grundlæggende dokumentationsform er flowcharts, men man kan også lave noget dokumentation ved hjælp af god kodestruktur og forklaringer hertil.

Dokumentation med State-machines

Specielt i de mere komplicerede programmer kan en anden dokumentationsform og kodeteknik blive relevant - state-machines.