Ako napísať technickú špecifikáciu (s obrázkami)

Technická špecifikácia (technická špecifikácia) je dokument, ktorý vysvetľuje, čo bude produkt alebo projekt robiť a ako tieto ciele dosiahnete. V technickej špecifikácii ukážte klientovi a členom tímu, aký problém riešite, aké sú ciele alebo požiadavky na váš projekt alebo produkt a ako to plánujete dosiahnuť. Technická špecifikácia usmerňuje prácu, ktorá sa má vykonať, a zvyčajne ju budete prepisovať v priebehu projektu.

Časť 1 z 3:Písanie hlavičky


Uveďte názov projektu v hornej časti, pričom použite bezserifové písmo s veľkosťou 14 alebo 16 bodov. Toto je názov vášho produktu alebo pracovný názov samotného projektu. Použite bezserifové písmo s veľkosťou 14 alebo 16 bodov, aby sa dalo ľahko čítať. V závislosti od vašich preferencií ju zarovnajte doľava alebo do stredu.[1]

  • Vaše pracovisko alebo inštruktor vám môže poskytnúť šablónu, ktorá vám ukáže, ako napísať názov. Vždy postupujte podľa šablóny, ak je k dispozícii.

Vedeli ste, že? Bezserifové písmo nemá koncové ťahy na písmenách, takže tieto štýly majú modernejší vzhľad. Najobľúbenejšie bezserifové písma sú Arial, Calibri a Verdana.


Napíšte dátum pod názov projektu 12-percentným bezserifovým písmom. Prejdite na ďalší riadok a zmenšite veľkosť písma na 12 bodov. Použite rovnaké bezserifové písmo, aké ste použili na napísanie názvu projektu. Potom zadajte dátum pomocou mesiaca, dňa a roku.[2]

  • Ak je vaša šablóna iná, naformátujte dátum podľa šablóny.
  • Je dôležité uviesť dátumy, aby ste mohli povedať, ktorá technická špecifikácia je najnovšia.


Pod dátum napíšte „Autor“ a meno autora. Prejdite na ďalší riadok a napíšte „Autor“, za ktorým nasleduje dvojbodka. Potom uveďte svoje meno, keďže technickú špecifikáciu píšete vy. Vždy uvádzajte len svoje meno, aj keď ste obsah technickej špecifikácie prediskutovali s tímom.[3]

  • Technická špecifikácia musí mať vždy jedného autora, aj keď pracujete s tímom. Autor je osoba, ktorá špecifikáciu skutočne napísala.


Umiestnite „Tím“ a mená členov tímu ako posledné. Do ďalšieho riadku napíšte „Tím“, za ktorým nasleduje dvojbodka. Potom vypíšte mená všetkých členov tímu, ktorí pracujú na projekte alebo produkte.[4]

  • Okrem toho, že to členom vášho tímu poskytne kredit, pomôže to ľuďom pochopiť, na koho sa môžu obrátiť, ak majú otázky týkajúce sa technickej špecifikácie.
  • Ak ste na projekte pracovali sami, tento krok vynechajte.

Časť 2 z 3: Príprava technickej špecifikácie


Uveďte prehľad alebo stručné zhrnutie projektu alebo produktu. Technickú špecifikáciu začnite zhrnutím toho, čo robíte. Ako nadpis zadajte „Prehľad“ alebo „Stručné zhrnutie“. Vysvetlite problém, potom zhrňte, čo je projekt alebo produkt a čo bude robiť. Ďalej vysvetlite, aký bude váš prístup k jeho dosiahnutiu, a uveďte špecifikácie výrobku, ak ide o zariadenie. Odkazy na všetky marketingové alebo technické dokumenty, ktoré sú pre projekt dôležité. Nakoniec uveďte hrubý časový odhad, ako dlho bude trvať dokončenie projektu alebo produktu.[5]

  • Mohli by ste napísať: „Súčasný systém plánovania tranzitných ciest v celom okrese spôsobuje, že cestujúci uviaznu a znižuje počet cestujúcich na niektorých trasách. Dva z autobusových systémov umožňujú cestujúcim plánovať cestu online, ale tretí používa papierové mapy a telefonický kontakt. Toto riešenie znižuje počet cestujúcich a spôsobuje nedostatočné financovanie, pozri výsledky prieskumu z jari 2019. Chceme presunúť všetky 3 tranzitné linky do 1 plánovacieho systému, ku ktorému majú používatelia prístup online. To im umožní ľahšie plánovať svoje cesty a zistiť, kedy budú autobusy na jednotlivých zastávkach. Okrem toho môžu cestujúci okamžite nahlásiť problémy pomocou funkcie „kontaktujte nás.“


Zahrňte časť o cieľoch, ak nie sú v prehľade alebo v stručnom zhrnutí. Do záhlavia napíšte „Ciele“ a potom stručne načrtnite, čo plánujete dosiahnuť svojím projektom alebo produktom. Napíšte úvodné vyhlásenie a potom uveďte svoje ciele v očíslovanom zozname alebo zozname s odrážkami.[6]

  • Ak svoje ciele načrtnete v časti prehľadu, túto časť zvyčajne nepotrebujete. Môže sa však od vás vyžadovať, aby ste túto časť zahrnuli, ak to vyžaduje vaše pracovisko.
  • Napíšte niečo ako: „Nový systém bude obsahovať: 1) nástroj na plánovanie trasy; 2) funkciu vyhľadávania autobusov; 3) spôsob, akým môžu cestujúci nahlasovať problémy.“


Požiadavky na produkt napíšte do samostatnej časti. Ďalej ako záhlavie napíšte „Požiadavky na produkt“ a potom veci, ktoré musí váš produkt robiť, aby vyriešil váš problém. Použite zoznam odrážok a netrápte sa úvodnou vetou.[7]

  • Napríklad: „1) Plánovač trás zabezpečuje, aby cestujúci neuviazli a autobusy neboli nedostatočne využívané; 2) Kontaktná schránka umožňuje plánovačom dopravy priamo reagovať na problémy cestujúcich.“


Vysvetlite veci, ktoré sú mimo rozsahu vášho projektu. Túto časť nazvite „Mimo rozsahu pôsobnosti“ alebo „Bez cieľa.“ Nepíšte úvod alebo odseky. Namiesto toho vytvorte bodový zoznam vecí, ktoré sa nechystáte urobiť, aby ste vyriešili svoj problém. Zahŕňa prácu, ktorú nebudete robiť, riešenia, ktoré podľa vás nebudú fungovať, a atribúty, ktoré váš produkt alebo projekt nebude mať. Buďte dôkladní, aby klient a váš tím nemali žiadne nedorozumenia.[8]

  • Môžete napísať: „1. Tento systém nepridá nové autobusové linky; 2. Na zastávkach ani v autobusoch nebudeme inštalovať počítače, takže cestujúci budú musieť používať vlastné zariadenia; 3. Plánovači dopravy nezaručia okamžité riešenie problémov cestujúcich; a 4. Táto služba nebude zahŕňať odvoz od dverí k dverám.“

Variácia: Niekedy sa táto časť umiestňuje na koniec technickej špecifikácie pred časový harmonogram. Použite svoje preferované umiestnenie alebo urobte to, čo je na vašom pracovisku najbežnejšie.


Ak máte nevyriešené otázky, uveďte časť „Otvorené otázky“. Vaša technická špecifikácia je stručný náčrt produktu alebo projektu, aby váš klient pochopil, čo dostáva, a aby váš tím pracoval na rovnakých cieľoch. Netrápte sa tým, že musíte zahrnúť každý detail alebo odpovedať na otázky „bude rozhodnuté“. Namiesto toho napíšte nadpis „Otvorené otázky“ a prezentujte zoznam vecí, o ktorých sa rozhodnete neskôr.[9]

  • Napíšte: „1) Ako budeme spravovať aktualizácie systému? 2) Budeme meniť mapy trás, ak zistíme problém? 3) Môže systém slúžiť cestujúcim vo viacerých jazykoch bez chýb v preklade? 4) Ako budeme najlepšie slúžiť jazdcom, ktorí nie sú technicky zdatní?“


Predstavte svoj plán v časti „Prístup“. Túto časť nazvite buď „Plán“, alebo „Prístup“.“ Popíšte, ako vyriešite problém alebo rôzne prístupy, ktoré zvažujete, ak nebolo prijaté konečné rozhodnutie. Vysvetlite svoj výskum a každú technológiu alebo proces, ktorý použijete. Ak je to možné, pripojte ilustrácie, grafy a schémy, aby čitatelia vášmu plánu ľahšie porozumeli. Nakoniec prediskutujte, ako budete svoj plán testovať a čo budete robiť, ak sa vyskytnú problémy.[10]

  • Ak opisujete rôzne prístupy alebo technológie, vytvorte pre každú z nich podkapitolu, aby sa váš plán dal ľahko sledovať.
  • Napíšte niečo ako: „V spolupráci s tímom pre plánovanie dopravy navrhneme softvér, ktorý umožní cestujúcim zadávať svoje ciele do aplikácie, ktorá im vygeneruje trasu. Jazdci potom môžu zmeniť trasu, ak si to želajú. Systém bude posielať cestujúcim textové aktualizácie, aby im pomohol nájsť ich trasy. Necháme jazdcov vo výbore zainteresovaných strán otestovať softvér predtým, ako ho sprístupníme verejnosti. Ak má plán chyby, aktualizácie stránky vykonáme počas hodín, keď sú autobusy mimo prevádzky. Okrem toho budeme mať k dispozícii dodatočný autobus na vyzdvihnutie cestujúcich, ktorí uviazli kvôli systému.“

Variácia: Na začiatku môžete uviesť časť „Komponenty“, v ktorej zhrniete, čo bude váš plán alebo prístup zahŕňať. Toto je však zvyčajne nepovinné, pokiaľ to vaše pracovisko alebo inštruktor nevyžaduje.[11]


Uveďte ďalšie možnosti, ktoré ste zvažovali, ale vylúčili. Túto časť umiestnite ako čiastkový krok vo svojom pláne alebo prístupe alebo ju umiestnite na koniec špecifikácie pred časový harmonogram. Napíšte nadpis „Zvažované iné možnosti“ a potom opíšte alternatívy, ktoré ste zvažovali pred výberom súčasného plánu. Vysvetlite, prečo ste vylúčili každú možnosť.[12]

  • Môžete napísať: „Zvažovali sme farebné mapy, pretože je to lacnejšia možnosť, ale jazdci nereagovali dobre na existujúce mapy a testovacia skupina bola zmätená.“


Opíšte svoje metódy a metriky na hodnotenie produktu alebo projektu. Zahrňte tieto informácie do jednej časti alebo do viacerých častí. Nazvite ho napríklad „Meranie vplyvu“ alebo „Monitorovanie“ a „Metriky“.“ V jednom alebo viacerých odsekoch vysvetlite, ako sa uistíte, že váš produkt alebo projekt funguje správne a dosahuje vaše ciele. Okrem toho opíšte, ako budete kontrolovať chyby alebo problémy.[13]

  • Uveďte konkrétne analytické postupy alebo technológie, ktoré použijete.
  • Povedzte niečo ako: „Porovnáme predpokladané časy trasy so skutočnými časmi trasy, aby sme sa uistili, že autobusy jazdia podľa cestovného poriadku. Okrem toho vykonáme prieskum medzi jazdcami, aby sme vyhodnotili ich spokojnosť a identifikovali problémy so systémom.“


Uveďte, ako zabezpečíte bezpečnosť a súkromie. Napíšte nadpis „Bezpečnosť a ochrana osobných údajov“ a potom vysvetlite, ako budete chrániť používateľov pred kybernetickými útokmi. Stručne opíšte riziká a spôsob zabezpečenia systému tak, aby bolo chránené súkromie. Napíšte niekoľko odsekov, v ktorých vysvetlíte svoje metódy.[14]

  • Vždy existujú riziká alebo obavy, preto v tejto časti neuvádzajte „neexistujú žiadne riziká“.
  • Môžete napísať: „Používatelia zadajú svoju polohu a adresu svojho bydliska. Okrem toho budú mať možnosť vytvoriť si profil a ukladať cesty. Na ochranu týchto údajov zahrnieme šifrovanie a firewall.“


Ukončite časovou osou a zoznamom míľnikov. Časový plán pomáha udržať projekt na správnej ceste a informuje klienta aj váš tím o tom, čo je potrebné urobiť. Túto časť nazvite „Časová os“ a potom rozdeľte úlohy podľa toho, kto ich vykonáva. Uveďte zoznam odrážok pre každý tím alebo člena tímu, v závislosti od vašich preferencií.[15]

  • V rozpise úloh môžete napríklad uviesť „Tím inžinierov“, „Tím plánovačov“, „Marketing“ a „Zabezpečenie kvality“.“
  • Váš zoznam odrážok pre technický tím by mohol obsahovať úlohy typu: „1) Napísať aktualizáciu webovej stránky; 2) Napísať aplikáciu na plánovanie výletov; 3) Napísať kontaktný systém.“

Časť 3 z 3: Dokončenie technickej špecifikácie


Urobte v dokumente jedno riadkovanie a medzi jednotlivými časťami vynechajte 1 riadok. Používajte jednoduché riadkovanie, aby bola vaša technická špecifikácia kratšia a ľahšie sa s ňou pracovalo. Keď chcete zmeniť odseky alebo časti, stačí preskočiť 1 riadok. To pomáha čitateľovi držať krok bez toho, aby pribúdali zbytočné strany.[16]

  • Vaše pracovisko alebo inštruktor vám môže dať iné pokyny na formátovanie. Ak áno, postupujte podľa týchto pokynov.


V celej technickej špecifikácii používajte pohľad prvej osoby. Keďže diskutujete o práci, ktorú vykonáte vy a váš tím, vždy používajte zámená v prvej osobe „ja“, „mňa“, „my“ a „nás“.“ Keď sa odvolávate na konkrétny tím alebo osobu, použite ich meno, aby bolo jasné, o kom hovoríte. Vďaka tomu je technická špecifikácia priama a výstižná, pretože čitateľ vie, ako bude vykonávať jednotlivé činnosti.[17]

  • Napríklad povedzte: „Špecifikácie budeme aktualizovať podľa potreby“ namiesto „Špecifikácie sa budú aktualizovať podľa potreby“.“
  • Podobne napíšte „Tím inžinierov napíše webovú stránku“ alebo „Amy vypracuje marketingový plán“.“


Píšte jasný a výstižný text, ktorý je ľahko zrozumiteľný. V technickej špecifikácii nerozvíjajte svoje nápady, pretože tým strácate svoj čas aj čas čitateľa. Použite čo najmenej slov na vyjadrenie svojich myšlienok a usporiadajte ich tak, aby sa dali ľahko sledovať. Prejdite si svoju správu a odstráňte zbytočné formulácie a opakujúce sa vety, aby bola vaša správa priamočiarejšia.[18]

  • Napríklad by ste mohli prepracovať „Napíšeme webovú stránku, ktorá umožní cestujúcim naplánovať si požadovanú cestu a sledovať autobus“ na „Táto webová stránka umožňuje plánovanie cesty a sledovanie autobusu.“


Požiadajte partnera o preskúmanie vašej technickej špecifikácie a poskytnite mu spätnú väzbu. Zdieľajte svoju technickú špecifikáciu s členom tímu alebo spolužiakom, ktorý jej bude rozumieť. Požiadajte ich, aby označili chyby, ktoré vidia, a poskytli vám spätnú väzbu o tom, kde môžete urobiť vylepšenia.[19]

  • Neukazujte svoju technickú špecifikáciu niekomu, kto nerozumie vašej oblasti. Pravdepodobne budú zmätení a môžu odporučiť zmeny, ktoré nie sú potrebné.


Revidujte svoju technickú špecifikáciu, ak sú potrebné zmeny. Na základe spätnej väzby, ktorú ste dostali, prejdite späť svoju technickú špecifikáciu a urobte revízie, ak ich považujete za potrebné. Zamerajte sa na to, aby bola technická špecifikácia zrozumiteľná pre klientov a váš tím. Netrápte sa však tým, že to nie je dokonalé.[20]

  • Technickú špecifikáciu budete pravdepodobne musieť aktualizovať podľa toho, ako bude váš projekt alebo produkt napredovať. Toto je dočasný dokument, preto nedovoľte, aby vám bránil v skutočnej práci.

  • Predtým, ako svoju technickú špecifikáciu rozošlete, si ju overte. Technickú špecifikáciu si prečítajte aspoň dvakrát a skontrolujte, či v nej nie sú chyby. Ak môžete, prečítajte si ho nahlas, aby ste si pomohli zachytiť chyby. Zamerajte sa na veci, ako sú preklepy alebo slová, ktoré by mohli zmeniť význam vášho dokumentu.[21]

    • Hľadajte napríklad chyby typu „súčasný systém je efektívny“ namiesto „súčasný systém je neefektívny.“
  • Odkazy