Tehniline spetsifikatsioon (tehniline spetsifikatsioon) on dokument, mis selgitab, mida toode või projekt teeb ja kuidas need eesmärgid saavutate. Tehnilises spetsifikatsioonis näidake oma kliendile ja meeskonnaliikmetele, millist probleemi te lahendate, millised on teie projekti või toote eesmärgid või nõuded ning kuidas kavatsete seda saavutada. Tehniline spetsifikatsioon suunab töö ära tegema ja tavaliselt kirjutate selle projekti edenedes ümber.
1
Pange projekti nimi ülaossa, kasutades 14-pt või 16-pt sans serif fonti. See on teie toote nimi või projekti enda tööpealkiri. Kasutage sans serif fonti 14- või 16-pt, et seda oleks lihtne lugeda. Sõltuvalt teie eelistustest joonda seda vasakul või keskel. Teie töökoht või juhendaja võib teile pakkuda malli, mis näitab, kuidas pealkirja kirjutada. Kui see on saadaval, järgige alati malli.
2
Kirjutage kuupäev projekti nime alla 12-punktises sans serif-fondis. Minge järgmisele reale ja vähendage fondi suurust 12-punktini. Kasutage sama sans serif fonti, mida kasutasite oma projekti nime kirjutamiseks. Seejärel sisestage kuupäev, kasutades kuud, päeva ja aastat. Kui teie mall on erinev, vormindage kuupäev vastavalt mallile. Tähtis on lisada kuupäevad, et saaksite aru, milline tehniline spetsifikatsioon on kõige värskem.
3
Tippige kuupäeva alla “Autor” ja autori nimi. Minge järgmisele reale ja kirjutage “Autor”, millele järgneb koolon. Seejärel sisestage oma nimi, kuna tehnilisi andmeid kirjutate just teie. Sisestage alati ainult oma nimi, isegi kui arutasite oma tehnilise spetsifikatsiooni sisu meeskonnaga. Tehnilisel spetsifikatsioonil peab alati olema üks autor, isegi kui töötate koos meeskonnaga. Autor on isik, kes tegelikult spetsifikatsiooni koostab.
4
Asetage “Meeskond” ja viimaseks meeskonnaliikmete nimed. Tippige järgmisele reale “Meeskond”, millele järgneb koolon. Seejärel kirjutage üles iga projekti või toote kallal töötava meeskonnaliikme nimed.Lisaks oma meeskonnaliikmete tunnustamisele aitab see inimestel mõista, kelle poole nad võivad pöörduda, kui neil on tehniliste andmete kohta küsimusi.Kui töötasite üksi selle projekti puhul jätke see samm vahele.
5
Esitage ülevaade või lühikokkuvõte projektist või tootest. Alustage tehnilist spetsifikatsiooni oma tegemiste kokkuvõttega. Sisestage päisesse “Ülevaade” või “Lühikokkuvõte”. Selgitage probleemi, seejärel tehke kokkuvõte, mis on projekt või toode ja mida see teeb. Järgmisena selgitage, milline on teie lähenemisviis selle saavutamiseks, ja lisage toote spetsifikatsioonid, kui see on varustus. Link mis tahes turundus- või inseneridokumentidele, mis on projekti jaoks olulised. Lõpuks esitage ligikaudne ajaprognoos selle kohta, kui kaua projekti või toote lõpetamine aega võtab. Võiksite kirjutada: “Praegune süsteem transiitreiside planeerimiseks kogu maakonnas jätab sõitjad hätta ja vähendab sõitjate arvu teatud liinidel. Kaks bussi süsteemid võimaldavad sõitjatel oma reisi veebis planeerida, kuid kolmas kasutab paberkaarte ja telefonikontakti. See lahendus vähendab sõitjate arvu ja põhjustab alarahastamist, vaadake 2019. aasta kevade uuringu tulemusi. Soovime viia kõik 3 ühistranspordiliini ühte planeerimissüsteemi, mida kasutajad saavad juurdepääs võrgus. See võimaldab neil oma reise hõlpsamini planeerida ja näha, millal bussid igas peatuses on. Lisaks saavad sõitjad probleemidest kohe teatada, kasutades funktsiooni „Võta meiega ühendust”.â€
6
Lisage eesmärkide jaotis, kui neid ülevaates või lühikokkuvõttes pole. Tippige päisesse “Eesmärgid”, seejärel kirjeldage lühidalt, mida kavatsete oma projekti või tootega saavutada. Kirjutage sissejuhatav avaldus ja seejärel loetlege oma eesmärgid nummerdatud või täpploendis. Kui kirjeldate oma eesmärgid ülevaate jaotises , ei ole teil tavaliselt seda jaotist vaja. Kui teie töökoht seda nõuab, võidakse teil siiski olla vaja selle jaotise lisamist.Kirjutage midagi sellist: “Uus süsteem sisaldab: 1) marsruudi planeerimise tööriista; 2) siini asukoha määramise funktsioon; 3) Ratturite võimalus probleemidest teatada.â€
7
Kirjutage toote nõuded eraldi jaotisse. Järgmisena tippige päisesse “Tootenõuded”, millele järgneb asjad, mida teie toode peab teie probleemi lahendamiseks tegema. Kasutage täpploendit ja ärge muretsege sissejuhatava lause pärast. Näiteks “1) Marsruudi planeerija tagab, et sõitjad ei jääks ummikusse ja bussid ei oleks alakasutatud; 2) Kontaktkast võimaldab ühistranspordi planeerijatel sõitjaga seotud probleemidele otse vastata.â€
8
Selgitage asju, mis teie projekti ulatusest välja jäävad. Nimetage see jaotis “Eesmärgiga väljas” või “Mitteeesmärgid”. Ärge kirjutage sissejuhatust ega lõike. Selle asemel koostage loend asjadest, mida te ei kavatse oma probleemi lahendamiseks teha. See hõlmab tööd, mida te ei tee, lahendusi, mis teie arvates ei tööta, ja atribuute, mida teie tootel või projektil ei ole. Olge põhjalik, et kliendil ja teie meeskonnal ei tekiks arusaamatusi. Võite kirjutada: “1) see süsteem ei lisa uusi bussiliine; 2) me ei paigalda arvuteid bussipeatustesse ega bussidesse, nii et sõitjad teevad seda peavad kasutama oma seadmeid; 3) ühistranspordi planeerijad ei garanteeri sõitjate probleemidele viivitamatut lahendust ja 4) see teenus ei hõlma uksest ukseni pealetulemist.â€
9
Kui teil on lahendamata probleeme, lisage jaotis “Avatud küsimused”. Teie tehniline spetsifikatsioon on toote või projekti kiire ülevaade, et teie klient mõistaks, mida nad saavad, ja teie meeskond töötab samade eesmärkide nimel. Ärge muretsege kaasa arvatud kõik üksikasjad või vastates teie küsimustele, mis tuleb kindlaks määrata. Selle asemel tippige päis “Avatud küsimused” ja esitage täpploend asjadest, mille otsustate hiljem. Kirjutage: “1) Kuidas me haldame süsteemivärskendusi? 2) Kas probleemi avastamisel muudame marsruudikaarte? 3) Kas süsteem suudab teenindada mitmekeelset sõitu ilma tõlkevigadeta? 4) Kuidas me kõige paremini teenindame rattureid, kes pole tehnikateadlikud?
10
Esitage oma plaan jaotises “Lähenemine”. Nimetage see jaotis “Plaan” või “Lähenemisviis”. Kirjeldage, kuidas probleemi lahendate, või erinevaid lähenemisviise, mida kaalute, kui lõplikku otsust pole tehtud. Selgitage oma uurimistööd ja iga tehnoloogiat või protsessi, mida te kasutate. Võimalusel lisage illustratsioone, diagramme ja diagramme, et lugejatel oleks teie plaanist lihtsam aru saada. Lõpuks arutlege, kuidas oma plaani testida ja mida teete probleemide korral. Kui kirjeldate erinevaid lähenemisviise või tehnoloogiaid, looge igaühe jaoks alamjaotis, et teie plaani oleks lihtne jälgida. Kirjutage midagi sellist: “Me töötame koos transpordiplaneerimise meeskonnaga kavandada tarkvara, mis võimaldab sõitjatel sisestada oma sihtkohad rakendusse, mis loob neile marsruudi. Seejärel saavad sõitjad soovi korral marsruuti muuta. Süsteem saadab sõitjatele tekstivärskendusi, et aidata neil marsruute leida. . Lasime sidusrühmade komisjonis sõitjatel tarkvara testida enne selle avalikustamist. Kui plaanis on vigu, värskendame saiti tundidel, mil bussid on võrguühenduseta. Lisaks on meil lisabuss Buss on saadaval süsteemi tõttu hätta jäänud reisijate pealevõtmiseks.â€
11
Kaasake muud võimalused, mida kaalusite, kuid välistasite. Lisage see jaotis oma plaani või lähenemisviisi alametapiks või asetage see spetsifikatsiooni lõppu enne ajaskaala. Sisestage päis “Muud kaalutud valikud”, seejärel kirjeldage alternatiive, mida kaalusite enne praeguse plaani valimist. Selgitage, miks iga valiku välistasite. Võite kirjutada: “Kaalusime värvikoodiga kaarte, kuna see on odavam variant, kuid ratturid ei reageerinud hästi olemasolevatele kaartidele ja katserühm sattus segadusse.â€
12
Kirjeldage oma meetodeid ja mõõdikuid toote või projekti hindamiseks. Lisage see teave ühte või mitmesse jaotisse. Nimetage see näiteks “Mõju mõõtmine” või “Jälgimine” ja “Mõõdikud”. Selgitage ühes või mitmes lõigus, kuidas veendute, et teie toode või projekt töötab õigesti ja täidab teie eesmärke. Lisaks kirjeldage, kuidas kontrollib vigu või probleeme.Kaasake konkreetsed kasutatavad analüütilised protsessid või tehnoloogiad.Öelge midagi sellist: “Võrdleme prognoositud marsruudiaegu tegelike marsruudiaegadega, et tagada busside graafikus. Lisaks viime läbi sõitjate küsitluse, et hinnata nende rahulolu ja tuvastada süsteemiga seotud probleemid.â€
13
Tehke kindlaks, kuidas pakute turvalisust ja privaatsust. Sisestage päis “Turvalisus ja privaatsus”, seejärel selgitage, kuidas kaitsete kasutajaid küberrünnakute eest. Kirjeldage lühidalt riske ja kuidas oma süsteemi kaitsta, et privaatsus oleks kaitstud. Kirjutage paar lõiku oma meetodite selgitamiseks. alati riskid või mured, nii et ärge pange sellesse jaotisesse “riske pole”. Võite kirjutada: “Kasutajad sisestavad oma asukoha ja koduaadressi. Lisaks on neil võimalus luua profiil ja salvestada Nende andmete kaitsmiseks lisame krüptimise ja tulemüüri.â€
14
Lõpetage ajaskaala ja verstapostide loend. Ajaskaala aitab hoida teie projekti õigel teel ja ütleb nii teie kliendile kui ka meeskonnale, mida tuleb teha. Nimetage see jaotis “Ajaskaala”, seejärel jaotage ülesanded vastavalt sellele, kes neid teeb. Lisage iga meeskonna või meeskonnaliikme täpploend, olenevalt teie eelistustest. Näiteks võib teie ülesannete jaotuses olla “Insenerimeeskond”, “Planeerimismeeskond”, “Turundus” ja “Kvaliteedi tagamine”. Teie insenerimeeskonna täpploend võib sisaldada selliseid ülesandeid nagu: “1) Kirjutage veebisaidi täiendus; 2) kirjutage reisi planeerimise rakendus; 3) Kirjutage kontaktsüsteem.â€
15
Tehke dokumendis üks tühik ja jätke jaotiste vahele üks rida vahele. Kasutage ühte vahekaugust, et teie tehnilised andmed oleksid lühemad ja hõlpsamini käsitsetavad. Kui soovite lõike või jaotisi muuta, jätke 1 rida vahele. See aitab lugejal sammu pidada ilma tarbetuid lehti lisamata. Teie töökoht või juhendaja võib anda teile erinevaid vormindamisjuhiseid. Kui jah, järgige neid juhiseid.
16
Kasutage oma tehnilises spetsifikatsioonis esimese isiku vaatepunkti. Kuna arutate tööd, mida teie ja teie meeskond teete, kasutage alati esimese isiku asesõnu “mina”, “mina”, “meie” ja “meie”. Kui viitate konkreetsele meeskonnale või inimesele, kasutage nende nime, et oleks selge, kellest räägite. See hoiab tehnilised spetsifikatsioonid otsesed ja täpsed, sest lugeja teab, kuidas iga toimingut sooritatakse. Näiteks öelge: “Värskendame spetsifikatsioone vastavalt vajadusele”, mitte “Tehnilisi andmeid värskendatakse vastavalt vajadusele”. “Insenerimeeskond kirjutab veebisaidi” või “Amy koostab turundusplaani.”
17
Kirjutage selge ja lühike tekst, mida on lihtne jälgida. Ärge täpsustage oma ideid tehnilistes kirjeldustes, sest see raiskab nii teie kui ka lugeja aega. Kasutage oma ideede väljendamiseks ja mõtete korraldamiseks nii vähe sõnu kui võimalik, et neid oleks lihtne jälgida. Vaadake oma aruanne läbi ja kõrvaldage mittevajalikud sõnastused ja korduvad laused, et teie aruanne oleks otsesem. Näiteks võite muuta jaotise “Kirjutame veebisaidi, mis võimaldab sõitjatel oma soovitud reisi planeerida ja bussiga kursis olla” ja “See veebisait võimaldab reisi planeerimine ja busside jälgimine.”
18
Paluge partneril teie tehnilised andmed üle vaadata ja tagasisidet anda. Jagage oma tehnilisi andmeid meeskonnaliikme või klassikaaslasega, kes seda mõistab. Paluge neil märkida vead, mida nad näevad, ja anda teile tagasisidet selle kohta, kus saate parandusi teha. Ärge näidake oma tehnilisi andmeid kellelegi, kes teie valdkonda ei mõista. Tõenäoliselt satuvad nad segadusse ja võivad soovitada muudatusi, mis pole vajalikud.
19
Kui vajate muudatusi, vaadake oma tehnilised andmed üle. Saadud tagasiside põhjal vaadake oma tehnilisi andmeid uuesti läbi ja tehke muudatusi, kui tunnete, et need on vajalikud. Keskenduge tehniliste andmete klientidele ja oma meeskonnale arusaadavaks muutmisele. Kuid ärge muretsege, et see pole täiuslik. Tõenäoliselt peate projekti või toote edenedes tehnilisi andmeid värskendama. See on ajutine dokument, nii et ärge laske sellel takistada teil tegelikku tööd tegemast.
20
Enne selle levitamist lugege oma tehniline spetsifikatsioon üle. Vigade kontrollimiseks lugege oma tehnilisi andmeid vähemalt kaks korda läbi. Kui saate, lugege see ette, et saaksite oma vigu mõista. Keskenduge asjadele, nagu kirjavead või sõnad, mis võivad teie dokumendi tähendust muuta. Otsige näiteks vigu, nagu “praegune süsteem on tõhus”, mitte “praegune süsteem on ebatõhus”.