Programmering 1, dokumentation
Hej, läser just nu programmering 1. Jag har en B-uppgift där jag ska skriva ett program och dokumentera samt utvärdera det.
Jag har skrivit programmet och är klar med programmeringen, men själva dokumentationen och utvärderingen har jag ingen aning om hur jag ska göra. Finns det någon som har en färdig dokumentation gjord som jag kan ta en titt på och få lite inspiration ifrån?
Har googlat, men inte hittat någonting konkret. Jag har hittat lite information men inget mer än så. Jag lär mig och förstår bättre om jag ser hur det är gjort.
Tack på förhand och vänliga hälsningar.
Dokumentation finns av flera sorter. Det finns användardokumentation, som ger den som ska använda programmet den information som den behöver, och det finns interndokumentation, som beskriver hur programmet är uppbyggt och hur det gör sitt jobb.
Användardokumentationen behöver inte berätta hur programmet ser ut inuti, bara hur man förväntas använda det: vad det gör, och sedan i detalj hur man ska mata in indata, och vilket format utdata har, osv.
Interndokumentationen hjälper den som ska förstå programmet och kanske modifiera det, så där står vilka algoritmer man använder, hur programflödet går, etc. En del av det kan bestå av kommentarer före varje metod eller klass, som berättar vad den metoden/klassen gör.
Vad det betyder att du själv ska utvärdera ditt program vet jag inte. Hade du vissa mål, som du kanske har uppfyllt eller inte?
Laguna skrev:Dokumentation finns av flera sorter. Det finns användardokumentation, som ger den som ska använda programmet den information som den behöver, och det finns interndokumentation, som beskriver hur programmet är uppbyggt och hur det gör sitt jobb.
Användardokumentationen behöver inte berätta hur programmet ser ut inuti, bara hur man förväntas använda det: vad det gör, och sedan i detalj hur man ska mata in indata, och vilket format utdata har, osv.
Interndokumentationen hjälper den som ska förstå programmet och kanske modifiera det, så där står vilka algoritmer man använder, hur programflödet går, etc. En del av det kan bestå av kommentarer före varje metod eller klass, som berättar vad den metoden/klassen gör.
Vad det betyder att du själv ska utvärdera ditt program vet jag inte. Hade du vissa mål, som du kanske har uppfyllt eller inte?
Hej Laguna, tack för ditt svar. Det är interndokumentation de är ute efter.
Såhär står det i uppgiften:
Uppgiften går ut på att du ska programmera, alltså
gå från algoritm till fungerande, väldokumenterad och testad kod
dokumentera och utvärdera processen och reflektera över vad du kan lära av den inför framtida programmeringsuppgifter
- Det ska framgå hur du har löst uppgiften (tips: för en logg när du arbetar)
- Dokumentationen av processen ska särskilt beskriva hur du arbetat
med felsökning, och helst visa att du har gjort det på ett strukturerat sätt.
utvärdera programmet och reflektera över hur det skulle kunna vidareutvecklas
- I utvärderingen av programmet ska du använda dig av begreppet
robusthet: ju fler olika situationer ett program kan hantera, och ju bättre programmet hanterar det, desto mer robust är det.
Utmaningar som programmet kan ställas inför är att användaren matar in värden man inte tänkt sig, eller som bryter mot de instruktioner som programmet ger användaren.
Det är bättre om programmet kan hantera sådana utmaningar utan att krascha, dvs. utan att det uppstår exekveringsfel, och på ett sätt som gör att användaren förstår vad som händer.
Mvh.
Det verkar krävas två helt olika sorters dokumentation: interndokumentation som du säger ("väldokumenterad kod") samt processdokumentation om hur du gick från spec till färdig kod. Håll dem helt separata (det kan bli viss upprepning då, men inte mycket).
Laguna skrev:Det verkar krävas två helt olika sorters dokumentation: interndokumentation som du säger ("väldokumenterad kod") samt processdokumentation om hur du gick från spec till färdig kod. Håll dem helt separata (det kan bli viss upprepning då, men inte mycket).
Ok, förstått. Tack ska du ha!
