Dokumentation

Dokumentation är något som är till för att hjälpa dig och dina medarbetare i en arbetssituation. I skolan är det ett verktyg för din lärare att få en inblick i din process och din förståelse av ämnet.

Kommunikationen kring projektet och att kunna berätta och beskriva projektet är viktigt, även om det så enbart rör sig om att förklara sitt eget projekt när en tittar på det 6 månader senare.

Undvik att skriva all dokumentation när allt det andra är klart. Det blir svårare, tråkigare och oftast kommer du inte ihåg allt det viktigt som du bör skriva ned.

Utvecklardagbok

Ett användbart trick för att dokumentera är att föra en utvecklardagbok. Skriv lite kort varje pass om vad du har gjort, vilka problem du stötte på, samt hur du löste dem. Försök även blicka framåt och skriv vad du behöver arbeta på nästa pass.

Git Commits

Försök att skapa vanan att skriva bra och tydliga commits till Git, det ökar tydligheten och är viktigt att öva.

Source: https://hashnode.com/post/which-commit-message-convention-do-you-use-at-work-ck3e4jbdd00zyo4s1h7mc7e0g/answer/ck4mwccd300qrdes173jqx2vw

Kommentarer