Kuidas korraldada töö tulemused aruandeks?
Kõigepealt määrake publik ja tõendite ulatus, seejärel nõudke selget struktuuri.
Selgitage, kellele aruanne on mõeldud
Aruande sisu tuleks korraldada lugejate ja selle eesmärgi ümber. Kui teete iseendale ülevaadet, võite säilitada rohkem protsessi üksikasju; arendajatele mõeldud aruandes rõhutage reprodutseerimistingimusi ja parandusnäpunäiteid; mitte-tehnilistele lugejatele mõeldud aruandes alustage mõju selgitamisest. Korraldamist taotledes täpsustage, milliseid kinnitatud materjale kasutada, sihtmahtu ja millist teavet ei tohi lõplikku versiooni lisada.
Esitage kontrollitav struktuur
Võite nõuda korraldamist tausta, ulatuse, meetodite, vaatluste, kontrollimata üksuste ja järgmiste sammude järgi. Turvalisuse leiud tuleks samuti linkida võimalikult palju vastavate tõenditega, mitte ainult riskimärgiste esitamisega. Esitamata testimisandmed tuleks märkida puuduvaks ja neid ei tohiks aruande täitmiseks välja mõelda.
- Näidake aruandega kaetud ülesandeid ja materjale.
- Täpsustage publik, formaat ja tõendid, mida tuleb säilitada.
- Nõudke kinnitatud järelduste ja soovituste eraldamist.
Teostage käsitsi ülevaatus enne edastamist
Kontrollige, kas nimed, kuupäevad, ulatus ja viited on täpsed, ning eemaldage duplikaadid ja ebavajalik tundlik sisu. Kui tulemused on ainult sõnumite kehade, saate need kopeerida ja salvestada; ainult siis, kui ilmuvad tegelikud allalaaditavad failid, peaksite failikirje kaudu alla laadima. Korralik aruande vorming ei tähenda, et järeldused oleksid kontrollitud; tööriista tõrked, katmata ulatused ja vastuolulised kirjed on samuti väärt säilitamist. Enne edastamist kontrollige ka, kas lõplik tekst säilitab vajalikud tingimused ja piirangud.