Kuidas koostada IT-aruannet

Olenemata sellest, kas olete ülikoolis või tööjõus, kirjeldab infotehnoloogia (IT) aruanne konkreetset tehnilist küsimust ja sellele küsimusele vastamiseks tehtud uuringuid. Uurimistöö tulemusena jõuate konkreetsete järeldusteni ja seejärel esitate soovitused selle kohta, kuidas oma järeldusi selles sektoris, kus õppisite või kus töötate, rakendada. IT-aruanded on koostatud nii, et lugejad ei pea tingimata iga jaotist läbi lugema. mõista oma leidude mõtet. Seetõttu on nende struktuur valemiline ja etteaimatav.

1
Looge oma aruandele tiitelleht. Teie aruande tiitelleht on tavaliselt eraldi leht, millele järgneb aruanne ise. Lisaks aruande pealkirjale sisaldab tiitelleht tavaliselt teie nime, kuupäeva ja seda, kellele te aruannet kirjutate. Näiteks kui olete koolis, sisaldab teie tiitelleht klassi nime kirjutate aruannet koos oma professori või instruktoriga. Kui kirjutate aruannet teatud kraadi täitmiseks, sisaldab tiitelleht tavaliselt vastavat keelt. Näiteks võite kirjutada “esitatud MSIT-kraadi nõuete täitmiseks”.

2
Joonistage iga jaotise pealkirjad. Mõned IT-aruande pealkirjad, sealhulgas sissejuhatus, kokkuvõte, viited ja lisad, on samad, olenemata teie aruande teemast. Aruande põhiosa puhul kajastavad teie pealkirjad aga konkreetset uuritud probleemi. IT-aruannetes kasutatakse tavaliselt tavalist kümnendnumbrite süsteemi. Peamised osad algavad numbriga “1.0” ja jätkuvad järjest. Alamjaotised on tähistatud “1.1”, alamjaotised “1.1.1” ja nii edasi. Veenduge, et kõigil pealkirjadel oleks ühtne ja paralleelne struktuur. Näiteks kui üks teie pealkirjadest oli gerundfraas, näiteks “Teabehaldusstiilide hindamine”, peaksid ülejäänud pealkirjad olema samas struktuuris.

3
Vormindage oma sisukord. Teie sisukord sisaldab kõiki teie aruande jaotisi ja alamjaotisi ning lehekülje numbrit, millest igaüks neist algab. Sisukorra abil on lugejal lihtne jaotiste vahel ringi liikuda. Enamikul tekstitöötlusprogrammidel on funktsionaalne mall, mis võimaldab teil sisukorra automaatselt luua. Sisukorras värskendatakse seejärel aruande mustandi koostamisel või muutmisel leheküljenumbreid.

4
Looge oma viidete loend, kasutades sobivat tsiteerimismeetodit. Kui vormindate oma viited enne aruande koostamist, saate need hõlpsamini ühendada, ilma et peaksite kirjutamist katkestama. Kui teil on vormindamisega seotud küsimusi, saate neid kohe kontrollida, ilma et see segaks. Kui te ei saa aru, kuidas ebahariliku allika viidet vormindada, peate võib-olla lõpetama aruande kirjutamise ja otsima viite jaotisest sobivast stiilijuhendist või veebist. Kui kirjutate aruannet pooleli, võib see teie aega ja tähelepanu üsna suure osa ära võtta.

5
Lisage oma aruandes kasutatud lühendite või tehniliste terminite sõnastik. Loetlege aruandes kasutatavad lühendid, akronüümid ja muud tehnilised terminid eraldi lehel aruande alguses. Nii ei pea te oma aruandes ruumi raiskama nende mõistete määratlemiseks. Kui te pole aruannet veel kirjutanud, ei pruugi teil täielikku loendit veel olla. Kui hakkate oma paberit toimetama, võite minna tagasi ja lisada sõnu, mis teil kahe silma vahele jäid.

6
Esitage sissejuhatuses taustteave. Sissejuhatuse eesmärk on asetada teie aruanne konteksti ja selgitada selle eesmärki. Võite lisada ka oma uurimisprotsessi ja oma töö tulemuste kokkuvõtte. Sissejuhatus sisaldab sageli lõiku, mis kirjeldab teie aruande struktuuri. Üldiselt on lihtsam oodata ja kirjutada see lõik pärast aruande valmimist, et tagada selle täpsus.

7
Kirjeldage leitud teavet ja tõendeid. Aruande põhiosa koosneb osadest, mis esitavad teie teavet koos näidete ja tõenditega teie uurimistööst. Korraldage see teave loogiliselt, kasutades sobivaid pealkirju ja alampealkirju, mis võimaldavad teie lugejal aruandes hõlpsalt navigeerida. Kuigi suurem osa teie tekstist peaks koosnema täislõikudest, saate vajaduse korral jagada ka suured tekstiplaadid täppide või nummerdatud loendite abil. .

8
Esitage oma leidude põhjal soovitusi. Teie soovitused erinevad olenevalt teie vaatajaskonnast ja aruande kirjutamise põhjusest. Üldiselt pakuvad teie soovitused konkreetseid soovitusi oma järelduste rakendamiseks või uurimistöö käigus leitud teabe rakendamiseks. Kui kirjutate ülikoolikeskkonnas, võivad teie soovitused sisaldada teie leidudest tulenevaid lisaküsimusi, mida võiks täiendavalt uurida. tehtud. Kui kirjutate töökohas, sisaldavad teie soovitused tõenäoliselt viise, kuidas teie tööandja saaks teie järeldusi rakendada või uurimistöö käigus avastatud probleeme parandada.

9
Vajadusel lisa lisad algandmete või muude detailidega. Lisad sisaldavad algandmeid, üksikasjalikke jooniseid, kodeerimist, arvutusi ja muud toetavat teavet, mis teie aruandesse ei mahtunud. Võite seda pidada teabeks, mis eeldab, et teie lugeja peaks teie aruandega “umbrohtu sattuma”. Lisades olev teave ei pruugi teie keskmisele lugejale huvi pakkuda, eriti kui kirjutate töökohas. Kuid see on teave, mida teised teadlased tahaksid uurida. Lisadele antakse tavaliselt number või täht ja pealkiri. Kui arutate oma tekstis konkreetse lisaga seotud teavet, kasutage lugejate tähelepanu juhtimiseks sulgudes olevat viidet. Näiteks võite kirjutada “Sotsiaalmeedia kasutamise kohta kogutud töötlemata andmed on toodud lisas 1”.

10
Looge kokkuvõte või abstraktne viimane. Kokkuvõte annab ülevaate teie aruandest hõivatud lugejatele, kes soovivad saada aru aruande põhiolemusest, ilma et peaksid kogu asja läbi lugema. Kuna see võtab teie aruande kokku, on tavaliselt lihtsam kirjutada, kui ootate aruande valmimiseni. Abiks võib olla aruande kirjutamise ajal kokkuvõttesse lisatava teabe ülesmärkimine. Lühema aruande jaoks kommenteeritud kokkuvõte on tavaliselt vaid 100–200 sõna. Kõige pikemal juhul võib see olla kuni lehekülg. Kuid see ei tohiks kunagi olla pikem kui lehekülg.

11
Kontrollige oma aruannet teile antud juhiste või juhiste alusel. Kui teie juhendajal või tööandjal olid teie aruande jaoks konkreetsed eesmärgid, lugege aruanne läbi ja veenduge, et see vastab kõigile nendele eesmärkidele. Kui pidite järgima konkreetseid juhiseid, kasutage neid kontroll-loendina, et veenduda, et olete oma ülesande täitnud. Kui konkreetse juhise või juhise järgimine osutus võimatuks, võiksite lisada oma aruandesse lause või kaks, tunnistab, et seda ei järgitud, ja selgitab põhjust.

12
Muutke aruannet järjepidevuse ja selguse huvides. Teie aruanne ei tohiks sisaldada kõnepruuki ega väga tehnilisi termineid ning see peaks olema tavainimesele kergesti mõistetav. Lugege oma aruanne ette, et tuvastada raskesti jälgitavad lõigud. Kui avastate end lugedes komistamas, on see märk sellest, et olete leidnud valdkonna, mis võiks natuke tööd teha. Veenduge, et aruandes esitatav teave oleks täielik ja täpne ning ilma lünkadeta või eeldusteta, mis paneksid lugeja seadke kahtluse alla teie järeldused või soovitused. Aruandest ülevaate loomine (mida mõnikord nimetatakse ka vastupidiseks kontuuriks) võib aidata teil lünki leida.

13
Parandage grammatika- ja kirjavahemärgivead. Jätke korrektuur oma aruande viimase või viimase redaktsiooni jaoks. Iga kord, kui muudate, võib tekkida uusi vigu, mis tähendab, et peate uuesti läbi lugema. Lugege aruannet aeglaselt, keskendudes igale lausele eraldi. Samuti võib see aidata lõpust alustada ja ühe sõna kaupa tagasi lugeda, et tuvastada võimalikke õigekirjavigu. Tõenäoliselt on teie tekstitöötlusprogrammis grammatika ja õigekirjakontroll. Kuid ärge lootke ainult nendele, sest nad jätavad sageli vead märkamata. Näiteks kui teil on homofoni õigekirjaviga (öelge sõna “loobumise” asemel “laine”), ei tuvasta õigekirjakontroll seda, kuna need on mõlemad sõnad.

14
Andke oma aruanne vigade kontrollimiseks vähemalt ühele inimesele. Kuna te kirjutasite oma aruande, pole te tingimata parim inimene selle redigeerimiseks. Värske silmapaar tabab asju, mida võite mitu korda vahele jätta. Hea mõte on lasta teie aruannet lugeda vähemalt ühel inimesel, kes ei tea teie aruande teemast midagi (või peaaegu mitte midagi). Nad võivad välja tuua kunstiterminid või segased fraasid, mis võisid teie tähelepanuta jääda.

15
Lõpetage oma sisukord, määratlused ja viited. Kui olete redigeerimise lõpetanud, kontrollige oma sisukorda, määratlusi ja viiteid, et veenduda, et need kajastavad teie aruannet endiselt täielikult. Värskendage aruande neid jaotisi, et lisada kõik muudatuste käigus tehtud täiendused.Kontrollige hoolikalt oma viidete kirjavahemärke ja vormingut, et veenduda, et need järgivad stiilijuhiseid, mida peaksite järgima.Kui kasutasite loomiseks automaatselt genereerivat malli oma sisukorda, kontrollige leheküljenumbreid ja veenduge, et need on õiged.

16
Lugege oma aruanne enne selle esitamist veel vähemalt korra läbi. Muutke korrektuur oma toimetamisprotsessi eraldi osaks. Ignoreeri oma aruande sisu ja keskendu mehaanikale – vormingule, kirjavahemärkidele ja õigekirjale.Veenduge, et kõik aruande pealkirjad ja arvud oleksid joondatud ja vormindatud järjepidevalt.Aruande sõnahaaval tagurpidi lugemine aitab keskendute õigekirjavigade parandamiseks üksikute sõnade õigekirjale. Ettelugemine võib aidata teil leida kirjavahemärkide vigu ja kohti, kus teie kiri ei ole nii selge kui võiks.