Ako napísať technickú špecifikáciu?

Ako mám napísať technickú špecifikáciu pre telový sprej?

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 svojim klientom a členom tímu, aký problém riešite, ciele alebo požiadavky na váš projekt alebo produkt a ako to plánujete dosiahnuť. Technická špecifikácia usmerňuje prácu, ktorú je potrebné vykonať, a zvyčajne ju prepíšete podľa postupu projektu.

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

1
Názov projektu umiestnite na vrchol pomocou bezpatkového písma s veľkosťou 14 alebo 16 bodov. Toto je názov vášho produktu alebo pracovný názov samotného projektu. Použite bezpatkové písmo v 14 alebo 16 bodoch, aby bolo čitateľné. V závislosti od vašich preferencií to odôvodnite vľavo alebo v strede.
- Vaše pracovisko alebo inštruktor vám môže poskytnúť šablónu, ktorá vám ukáže, ako napísať názov. Ak je k dispozícii, vždy sa riaďte vzorom.
Vedel si? Bezpatkové písmo nemá na písmenách koncové ťahy, takže tieto štýly majú modernejší vzhľad. Najviac populárne bezpätkové fonty sú Arial, Calibri a Verdana.
2
Pod názov projektu napíšte dátum 12-bodovým bezpatkovým písmom. Prejdite na nasledujúci riadok a zmenšte veľkosť písma na 12 bodov. Použite rovnaké bezpatkové písmo, aké ste použili na napísanie názvu projektu. Potom zadajte dátum pomocou mesiaca, dňa a roku.
- Ak je vaša šablóna odlišná, naformátujte dátum podľa šablóny.
- Je dôležité uviesť dátumy, aby ste vedeli, ktorá technická špecifikácia je najnovšia.
3
Pod dátum zadajte „autor“ a meno autora. Prejdite na nasledujúci riadok, napíšte „Autor“ a za ním dvojbodku. Potom zadajte svoje meno, pretože ste tým, kto píše technické špecifikácie. Vždy zadajte iba svoje meno, aj keď ste s tímom prediskutovali obsah svojich technických špecifikácií.
- Technická špecifikácia musí mať vždy jedného autora, aj keď pracujete s tímom. Autor je osoba, ktorá skutočne špecifikuje špecifikáciu.
4
Miesto „tím“ a mená členov tímu zadajte ako posledné. Do ďalšieho riadka zadajte „Tím“ a za ním dvojbodku. Potom napíšte mená každého člena tímu, ktorý pracuje na projekte alebo produkte.
- Okrem priznania kreditu členom vášho tímu to ľuďom tiež pomôže pochopiť, na koho sa môžu obrátiť, ak majú otázky týkajúce sa technických špecifikácií.
- Ak ste na tomto projekte pracovali sami, tento krok preskočte.

Ako napíšem technické špecifikácie kozmetických výrobkov RandD?

Časť 2 z 3: návrh technickej špecifikácie

1
Poskytnite prehľad alebo stručné zhrnutie projektu alebo produktu. Začnite svoje technické špecifikácie súhrnom toho, čo robíte. Do hlavičky zadajte „Prehľad“ alebo „Stručný súhrn“. Vysvetlite problém a potom zhrňte, čo je projekt alebo produkt a čo bude robiť. Ďalej vysvetlite, aký bude váš prístup k dosiahnutiu tohto cieľa, a zahrňte špecifikácie produktu, ak ide o vybavenie. Odkaz na akékoľvek marketingové alebo technické dokumenty, ktoré sú dôležité pre projekt. Nakoniec uveďte hrubý časový odhad, ako dlho bude trvať dokončenie projektu alebo produktu.
- Môžete napísať: „Súčasný systém plánovania tranzitných výletov cez okres ponecháva jazdcov na uzde a znižuje počet cestujúcich na určitých trasách. Dva z autobusových systémov umožňujú vodičom plánovať cestu online, ale tretí používa papierové mapy a telefónny kontakt. Toto riešenie znižuje počet cestujúcich a spôsobuje nedostatok financií, pozrite si výsledky prieskumu z jari 2019. Chceme presunúť všetky 3 tranzitné linky na 1 plánovací systém, ku ktorému budú mať používatelia prístup online. To im umožní jednoduchšie plánovať cesty a zistiť, kedy budú autobusy k dispozícii. každú zastávku. Okrem toho môžu jazdci okamžite nahlásiť problémy pomocou funkcie „kontaktujte nás“. "
2
Zahrňte časť cieľov, ak nie sú v prehľade alebo krátkom súhrne. Zadajte hlavičku „Ciele“ a potom stručne načrtnite, čo chcete pomocou projektu alebo produktu dosiahnuť. Napíšte úvodné vyhlásenie a potom zadajte svoje ciele do očíslovaného alebo odrážkového zoznamu.
- Ak načrtnete svoje ciele v sekcii prehľadu, túto sekciu zvyčajne nepotrebujete. Ak to však vaše pracovisko vyžaduje, môže sa od vás vyžadovať zahrnutie tejto sekcie.
- Napíšte niečo ako: „Nový systém bude zahŕňať: 1) nástroj na plánovanie trasy; 2) funkciu vyhľadávača autobusov; 3) spôsob, akým môžu jazdci hlásiť problémy.“
3
Napíšte požiadavky na produkt do samostatnej sekcie. Ďalej zadajte ako hlavičku „Požiadavky na produkt“ a za nimi veci, ktoré musí váš produkt urobiť, aby vyriešil váš problém. Použite zoznam odrážok a nerobte si starosti s úvodnou vetou.
- Napríklad: „1) Plánovač trasy zaisťuje, že vodiči nebudú uviaznutí a autobusy nebudú dostatočne využívané; 2) Kontaktné pole umožní plánovačom dopravy priamo reagovať na problémy s jazdcami.“
4
Vysvetlite veci, ktoré nepatria do rozsahu vášho projektu. Túto sekciu pomenujte „Mimo dosahu“ alebo „Necieľové ciele“. Nepíšte úvodnú stránku ani odseky. Namiesto toho si vytvorte odrážkový zoznam vecí, ktoré pre vyriešenie problému neurobíte. To zahŕňa prácu, ktorú nebudete vykonávať, riešenia, o ktorých si myslíte, že nebudú fungovať, a atribúty, ktoré váš produkt alebo projekt nebude mať. Buďte dôslední, aby klient a váš tím nemali žiadne nedorozumenia.
- Môžete napísať: „1) Tento systém nepridá nové autobusové trasy; 2) Nebudeme inštalovať počítače na autobusové zastávky ani do autobusov, takže jazdci budú musieť používať svoje vlastné zariadenia; 3) Plánovači dopravy nezaručia okamžité riešenia k problémom s jazdcom a 4) Táto služba nebude zahŕňať vyzdvihnutie z domu do domu. “
Obmena: Niekedy je táto časť umiestnená blízko konca technických špecifikácií pred časovou osou. Použite svoje preferované umiestnenie alebo robte to, čo je na vašom pracovisku najbežnejšie.
5
Ak máte nevyriešené problémy, zahrňte časť „otvorené otázky“. Vaše technické špecifikácie sú rýchlym nákresom produktu alebo projektu, aby váš klient porozumel tomu, čo dostáva, a váš tím pracuje na rovnakých cieľoch. Nebojte sa zahrnúť každý detail alebo odpovedať na svoje otázky „byť rozhodnutý“. Namiesto toho zadajte hlavičku „Otvorené otázky“ a predložte odrážkový zoznam vecí, o ktorých sa rozhodnete neskôr.
- Napíšte „1) Ako budeme spravovať aktualizácie systému? 2) Zmeníme mapy trás, ak nájdeme problém? 3) Môže systém slúžiť viacjazyčnému cestovaniu bez chýb v preklade? 4) Ako najlepšie poslúžime jazdcom, ktorí nie sú? nie si technicky zdatný? "
6
Prezentujte svoj plán v sekcii „Prístup“. Túto sekciu pomenujte 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ý budete používať. Ak je to možné, zahrňte ilustrácie, grafy a schémy, aby boli čitatelia pre váš plán jednoduchšie porozumieť. Nakoniec prediskutujte, ako otestujete svoj plán a čo urobíte v prípade problémov.
- Ak popisujete rôzne prístupy alebo technológie, pre každý vytvorte podsekciu, aby sa váš plán dal ľahko dodržať.
- Napíšte niečo ako: „V spolupráci s tímom pre plánovanie dopravy navrhneme softvér, ktorý umožní jazdcom zadať svoje ciele do aplikácie, ktorá im vygeneruje trasu. Jazdci potom môžu trasu zmeniť, ak si to želajú. Systém bude odosielať textové aktualizácie. jazdcom, aby im pomohli nájsť ich trasy. Necháme jazdcov na výbore zainteresovaných strán, aby softvér pred jeho zverejnením otestovali. Ak má plán chyby, aktualizácie webových stránok vykonáme v priebehu hodín, keď budú autobusy offline. Okrem toho budeme mať k dispozícii ďalší kyvadlový autobus, ktorý by vyzdvihol cestujúcich, ktorí kvôli systému uviazli. “
Obmena: V hornej časti môžete zahrnúť časť „Komponenty“, ktorá zhrnie, čo bude váš plán alebo prístup zahŕňať. Toto je však zvyčajne voliteľné, pokiaľ to nevyžaduje vaša spoločnosť alebo inštruktor.
7
Zahrňte ďalšie možnosti, ktoré ste zvažovali, ale vylúčili. Vložte túto sekciu ako čiastkový krok do svojho plánu alebo postupu alebo ho umiestnite na koniec špecifikácie pred svoju časovú os. Zadajte hlavičku „Zvažované ďalšie možnosti“ a potom popíšte alternatívy, ktoré ste zvažovali pred výberom aktuálneho plánu. Vysvetlite, prečo ste vylúčili každú možnosť.
- Môžete napísať: „Uvažovali sme o farebne odlíšených mapách, pretože je to lacnejšia možnosť, ale jazdci na existujúce mapy nereagovali dobre a testovaná skupina bola zmätená.“
Technická špecifikácia (technická špecifikácia) je dokument, ktorý vysvetľuje, čo bude produkt alebo projekt robiť a ako tieto ciele dosiahnete.
8
Popíšte svoje metódy a metriky na hodnotenie produktu alebo projektu. Zahrňte tieto informácie do jednej sekcie alebo viacerých sekcií. Zadajte názov napríklad „Meranie vplyvu“ alebo „Monitorovanie“ a „Metriky“. V jednom alebo viacerých odsekoch vysvetlite, ako zaistíte, aby váš produkt alebo projekt správne fungoval a dosahoval vaše ciele. Okrem toho popíšte, ako budete kontrolovať chyby alebo problémy.
- Zahrňte konkrétne analytické postupy alebo technológie, ktoré budete používať.
- Povedzte niečo ako: „Porovnáme predpokladané časy trás so skutočnými časmi trás, aby sme sa uistili, že autobusy jazdia podľa cestovného poriadku. Okrem toho vykonáme prieskum jazdcov, aby sme vyhodnotili ich spokojnosť a identifikovali problémy so systémom.“
9
Identifikujte, ako budete poskytovať zabezpečenie a súkromie. Zadajte hlavičku „Zabezpečenie a ochrana osobných údajov“ a potom vysvetlite, ako ochránite používateľov pred kybernetickými útokmi. Stručne popíšte riziká a spôsob, akým zabezpečíte svoj systém, aby bolo chránené súkromie. Napíšte pár odsekov a vysvetlite svoje metódy.
- Vždy existujú riziká alebo obavy, preto do tejto sekcie nedávajte „neexistujú žiadne riziká“.
- Môžete napísať: „Používatelia zadajú svoju polohu a adresu bydliska. Okrem toho budú mať možnosť vytvoriť si profil a ukladať výlety. Na ochranu týchto údajov zahrnieme šifrovanie a bránu firewall.“
10
Dokončite časovú os a zoznam míľnikov. Časová os pomáha udržať váš projekt na dobrej ceste a hovorí klientovi aj vášmu tímu, čo je potrebné urobiť. Nazvite túto sekciu názvom „Časová os“ a potom rozdeľte úlohy podľa toho, kto ich robí. Zahrňte zoznam odrážok pre každý tím alebo člena tímu, v závislosti od vašich preferencií.
- Rozdelenie vašej úlohy môže napríklad obsahovať zoznam „Inžiniersky tím“, „Plánovací tím“, „Marketing“ a „Zabezpečenie kvality“.
- Váš zoznam odrážok pre inžiniersky tím môže zahŕňať úlohy ako „1) Napíšte aktualizáciu webovej stránky; 2) Napíšte aplikáciu na plánovanie cesty; 3) Napíšte kontaktný systém.

Časť 3 z 3: Dokončenie vašich technických špecifikácií

1
Umiestnite dokument na jedno miesto a preskočte 1 riadok medzi sekciami. Používajte jednotlivé medzery, aby boli vaše technické špecifikácie kratšie a lepšie sa s nimi manipulovalo. Ak chcete zmeniť odseky alebo sekcie, preskočte 1 riadok. Pomáha to čitateľovi udržať krok bez pridávania zbytočných stránok.
- Pracovisko alebo inštruktor vám môžu poskytnúť rôzne pokyny pre formátovanie. Ak je to tak, postupujte podľa týchto pokynov.
2
V rámci svojich technických špecifikácií používajte pohľad z pohľadu prvej osoby. Keďže diskutujete o práci, ktorú budete so svojim tímom vykonávať, vždy používajte zámená prvej osoby „ja“, „ja“, „my“ a „my“. Keď máte na mysli konkrétny tím alebo osobu, použite ich meno, aby bolo jasné, o kom hovoríte. Vďaka tomu sú technické špecifikácie aktuálne a k veci, pretože čitateľ vie, ako bude každá akcia dokončená.
- Povedzme napríklad „radšej aktualizujeme špecifikácie podľa potreby“ než „špecifikácie sa budú aktualizovať podľa potreby“.
- Podobne napíšte „Technický tím napíše webovú stránku“ alebo „Amy navrhne marketingový plán“.
3
Napíšte jasný a stručný text, ktorý je ľahké sledovať. Neprespracujte svoje nápady v technickej špecifikácii, pretože to stráca čas aj čas vášho čitateľa. Na vyjadrenie svojich myšlienok a usporiadanie myšlienok použite čo najmenej slov, aby ste ich mohli ľahko nasledovať. Prejdite si svoju správu a odstráňte zbytočné formulácie a opakujúce sa vety, aby bola vaša správa presnejšia.
- Môžete napríklad zrevidovať „Napíšeme webovú stránku, ktorá umožní jazdcom naplánovať požadovanú cestu a sledovať autobus“ na „Tento web umožňuje plánovanie výletov a sledovanie autobusov“.
4
Požiadajte partnera, aby skontroloval vaše technické špecifikácie a poskytol spätnú väzbu. Podeľte sa o svoje technické špecifikácie s členom tímu alebo spolužiakom, ktorý im porozumie. Požiadajte ich, aby označili chyby, ktoré vidia, a poskytnú vám spätnú väzbu, kde je možné vykonať vylepšenia.
- Neukazujte svoje technické špecifikácie niekomu, kto nerozumie vášmu oboru. Pravdepodobne budú zmätení a môžu odporučiť zmeny, ktoré nie sú potrebné.
Ak chcete napísať technickú špecifikáciu, začnite najskôr vytvorením obsahu, v ktorom sú uvedené všeobecné požiadavky na výrobok alebo zostavu, a potom konkrétnejšími podsekciami.
5
V prípade potreby zrevidujte svoje technické špecifikácie. Na základe spätnej väzby, ktorú ste dostali, sa vráťte k technickým špecifikáciám a podľa potreby ich upravte. Zamerajte sa na to, aby boli technické špecifikácie zrozumiteľné pre klientov a váš tím. Nebojte sa však, že to nie je dokonalé.
- Ako váš projekt alebo produkt postupuje, budete pravdepodobne musieť aktualizovať svoje technické špecifikácie. Toto je dočasný dokument, takže vám to nesmie brániť v skutočnej práci.
6
Pred distribúciou skontrolujte svoje technické špecifikácie. Prečítajte si svoje technické špecifikácie najmenej dvakrát a skontrolujte chyby. Ak môžete, prečítajte si ho nahlas, aby ste pomohli pochopiť chyby. Zamerajte sa na veci, ako sú preklepy alebo slová, ktoré môžu zmeniť význam dokumentu.
- Hľadajte napríklad chyby typu „súčasný systém je účinný“ a nie „súčasný systém je neefektívny“.

Tipy

Váš zamestnávateľ alebo inštruktor môže požiadať o konkrétne sekcie, preto sa uistite, že spĺňate ich požiadavky. Stále však budete pokrývať rovnaké informácie.

Prečítajte si tiež: Ako napísať osnovu príbehu?

Ako napísať technickú špecifikáciu?

Kroky

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

Časť 2 z 3: návrh technickej špecifikácie

Časť 3 z 3: Dokončenie vašich technických špecifikácií

Tipy

Otázky a odpovede

Prečítajte si tiež: