Jak napsat technickou specifikaci (s obrázky)

Obsah:

Jak napsat technickou specifikaci (s obrázky)
Jak napsat technickou specifikaci (s obrázky)

Video: Jak napsat technickou specifikaci (s obrázky)

Video: Jak napsat technickou specifikaci (s obrázky)
Video: Jak nejít do školy kvůli testům? SKETCH 2024, Březen
Anonim

Technická specifikace (tech spec) je dokument, který vysvětluje, co produkt nebo projekt udělá a jak těchto cílů dosáhnete. V technické specifikaci ukažte svým klientům a členům týmu, jaký problém řešíte, cíle nebo požadavky na váš projekt nebo produkt a jak toho plánujete dosáhnout. Technická specifikace řídí práci, kterou je třeba provést, a obvykle ji přepíšete v průběhu projektu.

Kroky

Část 1 ze 3: Psaní záhlaví

Napište technickou specifikaci Krok 1
Napište technickou specifikaci Krok 1

Krok 1. Umístěte název projektu na začátek pomocí bezpatkového písma o velikosti 14 bodů nebo 16 bodů

Toto je název vašeho produktu nebo pracovní název samotného projektu. Použijte bezpatkové písmo ve 14 nebo 16 bodech, aby bylo snadno čitelné. Zarovnání doleva nebo zarovnání na střed, v závislosti na vašich preferencích.

Vaše pracoviště nebo instruktor vám mohou poskytnout šablonu, která vám ukáže, jak napsat titul. Vždy se řiďte šablonou, pokud je k dispozici

Věděl jsi?

Bezpatkové písmo nemá na dopisech koncové tahy, takže tyto styly mají modernější vzhled. Nejoblíbenější bezpatková písma jsou Arial, Calibri a Verdana.

Napište krok 2 technické specifikace
Napište krok 2 technické specifikace

Krok 2. Napište datum pod název projektu 12patrovým bezpatkovým písmem

Přejděte na další řádek a zmenšte velikost písma na 12 bodů. Použijte stejné bezpatkové písmo, jaké jste použili při psaní názvu projektu. Poté zadejte datum pomocí měsíce, dne a roku.

  • Pokud se vaše šablona liší, naformátujte datum podle šablony.
  • Je důležité zahrnout data, abyste mohli zjistit, která technická specifikace je nejnovější.
Napište technickou specifikaci Krok 3
Napište technickou specifikaci Krok 3

Krok 3. Pod datum zadejte „Autor“a jméno autora

Přejděte na další řádek, napište „Autor“a za ním dvojtečku. Poté zadejte své jméno, protože vy jste ten, kdo píše technické specifikace. Vždy zadejte pouze své jméno, i když jste obsah své technické specifikace projednali s týmem.

Technická specifikace musí mít vždy jednoho autora, i když pracujete s týmem. Autor je osoba, která ve skutečnosti zadává specifikaci

Napište krok 4 technické specifikace
Napište krok 4 technické specifikace

Krok 4. Umístěte „Tým“a jména členů týmu na poslední místo

Na dalším řádku zadejte „Tým“a poté dvojtečku. Poté napište jména všech členů týmu, kteří pracují na projektu nebo produktu.

  • Kromě poskytnutí kreditu členům vašeho týmu to lidem pomůže pochopit, na koho se mohou obrátit, pokud mají dotazy k technické specifikaci.
  • Pokud jste na tomto projektu pracovali sami, tento krok přeskočte.

Část 2 ze 3: Vypracování technické specifikace

Napište krok 5 technické specifikace
Napište krok 5 technické specifikace

Krok 1. Poskytněte přehled nebo stručné shrnutí projektu nebo produktu

Začněte své technické specifikace shrnutím toho, co děláte. Jako záhlaví zadejte „Přehled“nebo „Stručný souhrn“. Vysvětlete problém a poté shrňte, co je projekt nebo produkt a co bude dělat. Dále vysvětlete, jaký bude váš přístup k jeho dosažení, a zahrňte specifikace produktu, pokud jde o vybavení. Odkaz na jakékoli marketingové nebo technické dokumenty, které jsou pro projekt důležité. Nakonec uveďte hrubý časový odhad, jak dlouho bude trvat dokončení projektu nebo produktu.

Můžete napsat: „Stávající systém pro plánování tranzitních cest napříč krajem nechává jezdce na uzdě a snižuje počet cestujících na určitých trasách. Dva ze sběrnicových systémů umožňují jezdcům naplánovat si cestu online, ale třetí využívá papírové mapy a telefonní kontakt. Toto řešení snižuje počet cestujících a způsobuje nedostatečné financování, viz výsledky průzkumu z jara 2019. Chceme přesunout všechny 3 tranzitní linky na 1 plánovací systém, ke kterému mají uživatelé přístup online. To jim umožní snadněji plánovat cesty a zjistit, kdy budou autobusy na každé zastávce. Kromě toho mohou jezdci okamžitě hlásit problémy pomocí funkce „Kontaktujte nás“."

Napište krok 6 technické specifikace
Napište krok 6 technické specifikace

Krok 2. Zahrňte sekci cílů, pokud nejsou v přehledu nebo stručném shrnutí

Zadejte do záhlaví „Cíle“a poté stručně nastíňte, čeho chcete s projektem nebo produktem dosáhnout. Napište úvodní prohlášení a poté zadejte své cíle do očíslovaného nebo odrážkového seznamu.

  • Pokud své cíle nastíníte v sekci přehled, tuto sekci obvykle nepotřebujete. Pokud to však vaše pracoviště vyžaduje, může být vyžadováno zahrnutí této části.
  • Napište něco jako: „Nový systém bude zahrnovat: 1) nástroj pro plánování trasy; 2) Funkce lokátoru sběrnice; 3) Způsob, jakým mohou jezdci hlásit problémy. “
Napište krok 7 technické specifikace
Napište krok 7 technické specifikace

Krok 3. Napište požadavky na produkt v samostatné sekci

Dále zadejte do záhlaví „Požadavky na produkt“a poté věci, které váš produkt potřebuje k vyřešení vašeho problému. Použijte seznam odrážek a nedělejte si starosti s úvodní větou.

Například: „1) Plánovač tras zajišťuje, že jezdci nebudou uvíznout a autobusy nebudou dostatečně využívány; 2) Kontaktní pole umožňuje plánovačům dopravy přímo reagovat na problémy s jezdci. “

Napište krok 8 technické specifikace
Napište krok 8 technické specifikace

Krok 4. Vysvětlete věci, které jsou mimo rozsah vašeho projektu

Tuto sekci pojmenujte „Mimo dosah“nebo „Necílí“. Nepište úvodní list nebo odstavce. Místo toho si vytvořte odrážkový seznam věcí, které pro vyřešení problému neuděláte. To zahrnuje práci, kterou nebudete dělat, řešení, o kterých si myslíte, že nebudou fungovat, a atributy, které váš produkt nebo projekt nebude mít. Buďte důkladní, aby klient a váš tým neměli žádná nedorozumění.

Můžete napsat: „1) Tento systém nepřidá nové autobusové trasy; 2) Nebudeme instalovat počítače na autobusové zastávky nebo do autobusů, takže jezdci budou muset používat vlastní zařízení; 3) Plánovači tranzitu nezaručí okamžité řešení problémů jezdců; a 4) Tato služba nebude zahrnovat vyzvednutí z domu do domu. “

Variace:

Někdy je tato část umístěna blízko konce technické specifikace před časovou osou. Použijte své preferované umístění nebo dělejte to, co je na vašem pracovišti nejběžnější.

Napište technickou specifikaci, krok 9
Napište technickou specifikaci, krok 9

Krok 5. Pokud máte nevyřešené problémy, zahrňte sekci „Otevřené otázky“

Vaše technická specifikace je rychlý přehled produktu nebo projektu, takže váš klient rozumí tomu, co dostává, a váš tým pracuje na stejných cílech. Nedělejte si starosti se zahrnutím všech podrobností nebo zodpovězením svých otázek „být rozhodnut“. Místo toho zadejte záhlaví „Otevřené otázky“a předložte seznam věcí, o kterých se rozhodnete později.

Napište „1) Jak budeme spravovat aktualizace systému? 2) Změníme mapy tras, pokud zjistíme problém? 3) Může systém sloužit vícejazyčnému počtu cestujících bez chyb překladu? 4) Jak nejlépe posloužíme jezdcům, kteří nejsou technicky zdatní? “

Napište technickou specifikaci, krok 10
Napište technickou specifikaci, krok 10

Krok 6. Prezentujte svůj plán v sekci „Přístup“

Pojmenujte tuto sekci buď „Plán“nebo „Přístup“. Popište, jak budete problém řešit nebo různé přístupy, které zvažujete, pokud nebylo učiněno konečné rozhodnutí. Vysvětlete svůj výzkum a každou technologii nebo proces, který budete používat. Pokud je to možné, zahrňte ilustrace, grafy a diagramy, aby vaši čtenáři snáze porozuměli vašemu plánu. Nakonec si promluvte o tom, jak svůj plán otestujete a co uděláte v případě problémů.

  • Pokud popisujete různé přístupy nebo technologie, vytvořte pro každý podsekci, aby bylo možné váš plán snadno sledovat.
  • Napište něco jako: „Ve spolupráci s týmem pro plánování dopravy navrhneme software, který umožní jezdcům zadávat cíle do aplikace, která jim vygeneruje trasu. Jezdci pak mohou trasu změnit, pokud si to přejí. Systém bude jezdcům posílat textové aktualizace, které jim pomohou najít jejich trasy. Necháme jezdce ve výboru zúčastněných stran otestovat software, než jej zveřejníme. Pokud má plán chyby, provedeme aktualizace webu během hodin, kdy jsou autobusy offline. Kromě toho budeme mít k dispozici další kyvadlový autobus, který bude vyzvedávat cestující, kteří kvůli systému uvízli. “

Variace:

Nahoře můžete zahrnout sekci „Komponenty“, která shrne, co bude váš plán nebo přístup obnášet. To je však obvykle volitelné, pokud to vaše společnost nebo instruktor nevyžaduje.

Napište technickou specifikaci, krok 11
Napište technickou specifikaci, krok 11

Krok 7. Zahrňte další možnosti, které jste zvažovali, ale vyloučili

Umístěte tuto sekci jako dílčí krok do svého plánu nebo přístupu nebo ji umístěte na konec specifikace před svou časovou osu. Zadejte záhlaví „Další zvažované možnosti“a poté popište alternativy, které jste zvažovali před výběrem aktuálního plánu. Vysvětlete, proč jste každou možnost vyloučili.

Můžete napsat: „Zvažovali jsme barevně rozlišené mapy, protože je to levnější varianta, ale jezdci na stávající mapy nereagovali dobře a testovací skupina byla zmatená.“

Napište technickou specifikaci, krok 12
Napište technickou specifikaci, krok 12

Krok 8. Popište své metody a metriky pro hodnocení produktu nebo projektu

Zahrňte tyto informace do jedné nebo více sekcí. Pojmenujte to jako „Měření dopadu“nebo „Monitorování“a „Metriky“. V jednom nebo více odstavcích vysvětlete, jak zajistíte, aby váš produkt nebo projekt správně fungoval a dosahoval vašich cílů. Kromě toho popište, jak budete kontrolovat chyby nebo problémy.

  • Zahrňte konkrétní analytické postupy nebo technologie, které budete používat.
  • Řekněte něco jako: „Porovnáme předpokládané časy tras se skutečnými časy, abychom měli jistotu, že autobusy jedou podle plánu. Kromě toho provedeme průzkum mezi jezdci, abychom vyhodnotili jejich spokojenost a identifikovali problémy se systémem. “
Napište technickou specifikaci, krok 13
Napište technickou specifikaci, krok 13

Krok 9. Určete, jak budete zajišťovat zabezpečení a soukromí

Zadejte záhlaví „Zabezpečení a soukromí“a poté vysvětlete, jak budete uživatele chránit před kybernetickými útoky. Stručně popište rizika a způsob, jakým zabezpečíte svůj systém, aby bylo chráněno soukromí. Napište několik odstavců, abyste vysvětlili své metody.

  • Rizika nebo obavy vždy existují, proto do této části nedávejte „žádná rizika“nejsou.
  • Můžete napsat: „Uživatelé zadají svou polohu a svou domovskou adresu. Kromě toho budou mít možnost vytvořit si profil a ukládat výlety. Aby byla tato data chráněna, zahrneme šifrování a bránu firewall. “
Napište technickou specifikaci, krok 14
Napište technickou specifikaci, krok 14

Krok 10. Dokončete časovou osu a seznam milníků

Časová osa pomáhá udržet váš projekt na dobré cestě a říká vašemu klientovi i vašemu týmu, co je třeba udělat. Pojmenujte tuto sekci „Časová osa“a poté rozdělte úkoly podle toho, kdo je dělá. Zahrňte seznam odrážek pro každý tým nebo člena týmu, v závislosti na vašich preferencích.

  • V rozpisu vašich úkolů může být například seznam „Inženýrský tým“, „Plánovací tým“, „Marketing“a „Zabezpečení kvality“.
  • Váš seznam odrážek pro tým inženýrů může zahrnovat úkoly jako: „1) Napište upgrade webu; 2) Napište aplikaci pro plánování cesty; 3) Napište kontaktní systém. “

Část 3 ze 3: Dokončení vaší technické specifikace

Napište krok 15 technické specifikace
Napište krok 15 technické specifikace

Krok 1. Jednoduše umístěte dokument a přeskočte 1 řádek mezi sekcemi

Používejte jednoduché mezery, aby byly vaše technické specifikace kratší a lépe se s nimi manipulovalo. Pokud chcete změnit odstavce nebo části, přeskočte 1 řádek. To pomáhá čtenáři držet krok bez přidávání zbytečných stránek.

Vaše pracoviště nebo instruktor vám mohou poskytnout různé pokyny k formátování. Pokud ano, postupujte podle těchto pokynů

Napište technickou specifikaci, krok 16
Napište technickou specifikaci, krok 16

Krok 2. V celé své technické specifikaci použijte pohled z pohledu první osoby

Jelikož diskutujete o práci, kterou vy a váš tým zvládnete, vždy používejte zájmena první osoby „já“, „já“, „my“a „my“. Když mluvíte o konkrétním týmu nebo osobě, použijte jejich jméno, aby bylo jasné, o kom mluvíte. Díky tomu jsou technické specifikace přímo a k věci, protože čtenář ví, jak budou jednotlivé akce dokončeny.

  • Řekněte například „Aktualizujeme specifikace podle potřeby“, nikoli „Specifikace budou aktualizovány podle potřeby“.
  • Podobně napište „Technický tým napíše web“nebo „Amy navrhne marketingový plán“.
Napište krok 17 technické specifikace
Napište krok 17 technické specifikace

Krok 3. Napište jasný a stručný text, který je snadné sledovat

Nepropracovávejte své nápady v technické specifikaci, protože to ztrácí čas i čas vašeho čtenáře. Použijte co nejméně slov k vyjádření svých myšlenek a uspořádání myšlenek tak, aby se daly snadno sledovat. Projděte si svou zprávu a odstraňte zbytečné formulace a opakující se věty, aby byla vaše zpráva přímější.

Můžete například revidovat „Napíšeme web, který umožní jezdcům naplánovat požadovanou cestu a sledovat autobus“na „Tento web umožňuje plánování cesty a sledování autobusu“

Napište krok 18 technické specifikace
Napište krok 18 technické specifikace

Krok 4. Požádejte partnera, aby zkontroloval vaše technické specifikace a poskytl zpětnou vazbu

Sdílejte své technické specifikace s členem týmu nebo spolužákem, který to pochopí. Požádejte je, aby označili chyby, které vidí, a poskytli vám zpětnou vazbu o tom, kde lze provést vylepšení.

Neukazujte své technické specifikace někomu, kdo nerozumí vašemu oboru. Pravděpodobně budou zmatení a mohou doporučit změny, které nejsou nutné

Napište technickou specifikaci, krok 19
Napište technickou specifikaci, krok 19

Krok 5. V případě potřeby změňte technické specifikace

Na základě zpětné vazby, kterou jste obdrželi, si projděte své technické specifikace a proveďte revize, pokud to považujete za nutné. Zaměřte se na to, aby byly technické specifikace srozumitelné pro klienty a váš tým. Nebojte se však, že to není dokonalé.

Pravděpodobně budete muset během vývoje projektu nebo produktu aktualizovat své technické specifikace. Toto je dočasný dokument, nenechte ho proto zabránit ve vaší skutečné práci

Napište krok 20 technické specifikace
Napište krok 20 technické specifikace

Krok 6. Před distribucí zkontrolujte své technické specifikace

Přečtěte si alespoň dvakrát své technické specifikace a zkontrolujte chyby. Pokud můžete, přečtěte si to nahlas, abyste pomohli zachytit své chyby. Zaměřte se na překlepy nebo slova, která mohou změnit význam dokumentu.

Hledejte například chyby typu „současný systém je účinný“než „současný systém je neefektivní“

Doporučuje: