Hoe om 'n tegniese spesifikasie te skryf (met foto's)

INHOUDSOPGAWE:

Hoe om 'n tegniese spesifikasie te skryf (met foto's)
Hoe om 'n tegniese spesifikasie te skryf (met foto's)

Video: Hoe om 'n tegniese spesifikasie te skryf (met foto's)

Video: Hoe om 'n tegniese spesifikasie te skryf (met foto's)
Video: 9 Passive Income Ideas | How You Make $5000 A Month (Side Hustle Ideas) 2024, Maart
Anonim

'N Tegniese spesifikasie (tegniese spesifikasie) is 'n dokument wat verduidelik wat 'n produk of projek sal doen en hoe u hierdie doelwitte sal bereik. In 'n tegniese spesifikasie, wys u kliënt en spanlede watter probleem u oplos, die doelwitte of vereistes vir u projek of produk, en hoe u van plan is om dit te bereik. 'N Tegniese spesifikasie bepaal die werk wat u moet doen, en u sal dit gewoonlik herskryf namate u projek vorder.

Stappe

Deel 1 van 3: Skryf jou kop

Skryf 'n tegniese spesifikasie Stap 1
Skryf 'n tegniese spesifikasie Stap 1

Stap 1. Plaas die projeknaam bo-aan met 'n 14-pt of 16-pt sans serif-lettertipe

Dit is die naam van u produk of die werktitel van die projek self. Gebruik 'n sans serif-lettertipe in 14-pt of 16-pt, sodat dit maklik is om te lees. Afhangend van u voorkeure, regverdig dit of regverdig dit in die middel.

U werkplek of instrukteur kan u 'n sjabloon voorsien wat u wys hoe u u titel kan skryf. Volg altyd die sjabloon as een beskikbaar is

Het jy geweet?

'N Sans serif -lettertipe het nie eindstrepe op die letters nie, so hierdie style het 'n meer moderne voorkoms. Die gewildste sans serif -lettertipes is Arial, Calibri en Verdana.

Skryf 'n tegniese spesifikasie Stap 2
Skryf 'n tegniese spesifikasie Stap 2

Stap 2. Skryf die datum onder die projeknaam in 'n 12-pt sans serif lettertipe

Gaan na die volgende reël en verminder u lettergrootte tot 12 pt. Gebruik dieselfde sans serif -lettertipe as wat u gebruik het om u projeknaam te skryf. Tik dan die datum in met die maand, dag en jaar.

  • As u sjabloon anders is, formateer u datum volgens die sjabloon.
  • Dit is belangrik om datums in te sluit, sodat u kan sien watter tegnologie die nuutste is.
Skryf 'n tegniese spesifikasie Stap 3
Skryf 'n tegniese spesifikasie Stap 3

Stap 3. Tik "Skrywer" en die outeur se naam onder die datum

Gaan na die volgende reël en skryf 'Skrywer', gevolg deur 'n dubbelpunt. Gee dan u naam, aangesien dit die tegniese spesifikasie is. Gee altyd net u naam, selfs al het u die inhoud van u tegniese spesifikasie met 'n span bespreek.

'N Tegniese spesifikasie moet altyd een outeur hê, selfs al werk u saam met 'n span. Die outeur is die persoon wat die spesifikasie eintlik tik

Skryf 'n tegniese spesifikasie Stap 4
Skryf 'n tegniese spesifikasie Stap 4

Stap 4. Plaas “Team” en die name van die spanlede laaste

Tik op die volgende reël 'Team', gevolg deur 'n dubbelpunt. Skryf dan die name van elke spanlid wat aan die projek of produk werk, neer.

  • Behalwe om krediet aan u spanlede te gee, help dit mense om te verstaan na wie hulle kan gaan as hulle vrae het oor die tegniese spesifikasies.
  • Slaan hierdie stap oor as u alleen aan hierdie projek gewerk het.

Deel 2 van 3: Stel 'n tegniese spesifikasie op

Skryf 'n tegniese spesifikasie Stap 5
Skryf 'n tegniese spesifikasie Stap 5

Stap 1. Gee 'n oorsig of 'n kort opsomming van die projek of produk

Begin u tegniese spesifikasies met 'n opsomming van wat u doen. Tik 'Oorsig' of 'Kort opsomming' as u kop. Verduidelik die probleem en som dan op wat die projek of produk is en wat dit sal doen. Verduidelik vervolgens wat u benadering tot die bereiking daarvan is, en bevat produkspesifikasies as dit toerusting is. Skakel na enige bemarkings- of ingenieursdokumente wat van belang is vir die projek. Gee laastens 'n ruwe tydskatting oor hoe lank dit sal neem om die projek of die produk te voltooi.

U kan skryf: 'Die huidige stelsel vir die beplanning van transito -reise deur die land laat ruiters gestrand en verlaag die bestuurder op sekere roetes. Twee van die busstelsels stel ruiters in staat om hul reis aanlyn te beplan, maar die derde gebruik papierkaarte en telefoonkontak. Hierdie oplossing verlaag die aantal bestuurders en veroorsaak onderfinansiering, sien die uitslae van die opname in die lente van 2019. Ons wil al drie vervoerlyne oorplaas na 1 beplanningstelsel waartoe gebruikers aanlyn toegang kan verkry. Dit sal hulle toelaat om hul reise makliker te beplan en te sien wanneer die busse by elke stop sal wees. Daarbenewens kan ruiters probleme onmiddellik aanmeld met 'n 'kontak ons' -funksie."

Skryf 'n tegniese spesifikasie Stap 6
Skryf 'n tegniese spesifikasie Stap 6

Stap 2. Sluit 'n doelwitafdeling in as dit nie in die oorsig of kort opsomming is nie

Tik 'Doele' as 'n kop en gee kortliks 'n uiteensetting van wat u met u projek of produk wil bereik. Skryf 'n inleidende verklaring en lys u doelwitte in 'n genommerde of kolpuntlys.

  • As u u doelwitte in die oorsigafdeling uiteensit, benodig u hierdie afdeling gewoonlik nie. Dit kan egter nodig wees dat u hierdie afdeling insluit as u werkplek dit vereis.
  • Skryf iets soos: "Die nuwe stelsel sal die volgende insluit: 1) 'n hulpmiddel vir roetebeplanning; 2) 'n busopspoorfunksie; 3) 'n Manier waarop ruiters probleme kan aanmeld.
Skryf 'n tegniese spesifikasie Stap 7
Skryf 'n tegniese spesifikasie Stap 7

Stap 3. Skryf die produkvereistes in 'n aparte afdeling neer

Tik vervolgens 'Produkvereistes' as 'n kop, gevolg deur die dinge wat u produk moet doen om u probleem op te los. Gebruik 'n opsomminglys en moenie bekommerd wees oor 'n inleidende sin nie.

Byvoorbeeld, "1) Roetebeplanner verseker dat ruiters nie gestrand is nie en dat busse nie onderbenut word nie; 2) Met die kontakboks kan vervoerbeplanners direk reageer op probleme met die bestuurder.”

Skryf 'n tegniese spesifikasie Stap 8
Skryf 'n tegniese spesifikasie Stap 8

Stap 4. Verduidelik dinge wat buite die omvang van u projek val

Gee hierdie afdeling 'Out of Scope' of 'Non-Goals'. Moenie 'n inleiding of paragrawe skryf nie. Maak eerder 'n opsomminglys van die dinge wat u nie gaan doen om u probleem op te los nie. Dit sluit werk in wat u nie sal doen nie, oplossings wat u nie dink sal werk nie, en kenmerke wat u produk of projek nie sal hê nie. Wees deeglik sodat die kliënt en u span geen misverstande het nie.

U kan skryf: "1) Hierdie stelsel sal nie nuwe busroetes byvoeg nie; 2) Ons sal nie rekenaars by bushaltes of busse installeer nie, dus moet ruiters hul eie toestelle gebruik; 3) Transitbeplanners waarborg nie onmiddellike oplossings vir ruiterprobleme nie; en 4) Hierdie diens sal nie deur-tot-deur bakkies insluit nie.”

Variasie:

Soms word hierdie afdeling voor die tydlyn naby die einde van die tegniese spesifikasie geplaas. Gebruik u voorkeurplasing of doen wat die algemeenste in u werkplek is.

Skryf 'n tegniese spesifikasie Stap 9
Skryf 'n tegniese spesifikasie Stap 9

Stap 5. Sluit 'n gedeelte "Oop vrae" in as u onopgeloste probleme ondervind

U tegniese spesifikasie is 'n vinnige uiteensetting van die produk of projek, sodat u kliënt verstaan wat hulle kry en u span werk aan dieselfde doelwitte. Moenie bekommerd wees oor die feit dat u elke detail insluit of u 'vasberade' vrae beantwoord nie. Tik eerder die opskrif "Open Questions" en bied 'n opsomming van die dinge wat u later sal besluit.

Skryf, “1) Hoe sal ons stelselopdaterings bestuur? 2) Sal ons die roetekaarte verander as ons 'n probleem ondervind? 3) Kan die stelsel 'n veeltalige bestuurskap bied sonder vertaalfoute? 4) Hoe dien ons ruiters wat nie tegnies vaardig is nie, die beste?”

Skryf 'n tegniese spesifikasie Stap 10
Skryf 'n tegniese spesifikasie Stap 10

Stap 6. Stel u plan voor in die afdeling "Benadering"

Gee hierdie afdeling 'n plan of 'n benadering '. Beskryf hoe u die probleem of die verskillende benaderings wat u oorweeg, sal oplos as daar nie 'n finale besluit geneem is nie. Verduidelik u navorsing en elke tegnologie of proses wat u sal gebruik. Sluit indien moontlik illustrasies, kaarte en diagramme in, sodat dit makliker is vir u lesers om u plan te verstaan. Bespreek ten slotte hoe u u plan sal toets en wat u sal doen as daar probleme is.

  • As u verskillende benaderings of tegnologieë beskryf, skep 'n onderafdeling vir elkeen sodat u plan maklik kan volg.
  • Skryf iets soos: 'Ons werk saam met die vervoerbeplanningspan om sagteware te ontwerp waarmee ruiters hul bestemmings kan invoer in 'n app wat 'n roete vir hulle kan oplewer. Ruiters kan dan die roete verander as hulle wil. Die stelsel stuur teksopdaterings aan ruiters om hulle te help om hul roetes te vind. Ons gaan die ruiters in 'n belanghebbende komitee die sagteware laat toets voordat ons dit aan die publiek bekend maak. As die plan foute bevat, sal ons werfopdaterings maak gedurende ure wanneer die busse vanlyn is. Boonop sal ons 'n ekstra pendelbus beskikbaar hê om passasiers op te haal wat weens die stelsel gestrand is.”

Variasie:

U kan 'n gedeelte 'Onderdele' bo -aan insluit om op te som wat u plan of benadering sal behels. Dit is egter gewoonlik opsioneel, tensy u onderneming of instrukteur dit vereis.

Skryf 'n tegniese spesifikasie Stap 11
Skryf 'n tegniese spesifikasie Stap 11

Stap 7. Sluit die ander opsies in wat u oorweeg het, maar uitgesluit het

Plaas hierdie afdeling as 'n deel van u plan of benadering, of plaas dit aan die einde van u spesifikasie voor u tydlyn. Tik die opskrif "Ander opsies wat oorweeg word", en beskryf dan die alternatiewe wat u oorweeg het voordat u u huidige plan gekies het. Verduidelik waarom u elke opsie uitgesluit het.

U kan skryf: 'Ons het gekodeerde kaarte oorweeg, want dit is 'n goedkoper opsie, maar ruiters reageer nie goed op die bestaande kaarte nie en die toetsgroep raak verward.'

Skryf 'n tegniese spesifikasie Stap 12
Skryf 'n tegniese spesifikasie Stap 12

Stap 8. Beskryf u metodes en statistieke vir die evaluering van die produk of projek

Sluit hierdie inligting in een of meer afdelings in. Gee dit iets soos "Impact Measuring" of "Monitoring" en "Metrics". Verduidelik in een of meer paragrawe hoe u sal verseker dat u produk of projek korrek werk en u doelwitte bereik. Beskryf ook hoe u na foute of probleme sal kyk.

  • Sluit die spesifieke analitiese prosesse of tegnologieë in wat u sal gebruik.
  • Sê iets soos: 'Ons sal die geprojekteerde roostye vergelyk met die werklike roostye om seker te maak dat busse op skedule is. Boonop sal ons 'n ruiteropname doen om hul tevredenheid te evalueer en probleme met die stelsel te identifiseer.
Skryf 'n tegniese spesifikasie Stap 13
Skryf 'n tegniese spesifikasie Stap 13

Stap 9. Identifiseer hoe u sekuriteit en privaatheid sal bied

Tik die opskrif "Sekuriteit en privaatheid", en verduidelik dan hoe u gebruikers teen kuberaanvalle sal beskerm. Beskryf kortliks die risiko's en hoe u u stelsel sal beveilig sodat privaatheid beskerm word. Skryf 'n paar paragrawe om u metodes te verduidelik.

  • Daar is altyd risiko's of bekommernisse, dus moenie 'daar is geen risiko's' in hierdie afdeling plaas nie.
  • U kan skryf: 'Gebruikers sal hul ligging en hul huisadresse invoer. Boonop het hulle die opsie om 'n profiel te skep en reise te stoor. Om hierdie data te beskerm, sluit ons kodering en 'n firewall in.”
Skryf 'n tegniese spesifikasie Stap 14
Skryf 'n tegniese spesifikasie Stap 14

Stap 10. Voltooi met 'n tydlyn en 'n lys van mylpale

'N Tydlyn help om u projek op koers te hou en vertel u kliënt en u span wat gedoen moet word. Gee hierdie afdeling 'Tydlyn', en verdeel dan die take volgens wie dit doen. Sluit 'n opsomminglys in vir elke span of spanlid, afhangende van u voorkeure.

  • U taakverdeling kan byvoorbeeld 'Ingenieurspan', 'Beplanningspan', 'Bemarking' en 'Gehalteversekering' bevat.
  • U bullet -lys vir die ingenieurspan kan take insluit soos: "1) Skryf webwerf -opgradering; 2) Skryf reisbeplanningsprogram; 3) Skryf kontakstelsel.”

Deel 3 van 3: Die afhandeling van u tegniese spesifikasie

Skryf 'n tegniese spesifikasie Stap 15
Skryf 'n tegniese spesifikasie Stap 15

Stap 1. Maak 'n enkele spasie van u dokument en slaan 1 reël tussen afdelings oor

Gebruik 'n enkele afstand, sodat u tegniese spesifikasies korter en makliker hanteerbaar is. As u paragrawe of gedeeltes wil verander, slaan net 1 reël oor. Dit help die leser om by te bly sonder om onnodige bladsye by te voeg.

U werkplek of instrukteur kan u verskillende opmaakinstruksies gee. Indien wel, volg hierdie instruksies

Skryf 'n tegniese spesifikasie Stap 16
Skryf 'n tegniese spesifikasie Stap 16

Stap 2. Gebruik 'n eerste-persoon-oogpunt in u tegniese spesifikasie

Aangesien u werk bespreek wat u en u span sal verrig, gebruik altyd die voornaamwoord "ek", "ek", "ons" en "ons". As u na 'n spesifieke span of persoon verwys, gebruik hulle naam sodat dit duidelik is van wie u praat. Dit hou die tegniese spesifikasies direk en tot die punt, want die leser weet hoe hy elke aksie sal voltooi.

  • Sê byvoorbeeld: "Ons sal die spesifikasies na behoefte opdateer" eerder as "Die spesifikasies sal opgedateer word indien nodig."
  • Skryf ook "Die ingenieurspan sal 'n webwerf skryf" of "Amy sal 'n bemarkingsplan opstel."
Skryf 'n tegniese spesifikasie Stap 17
Skryf 'n tegniese spesifikasie Stap 17

Stap 3. Skryf duidelike en bondige teks wat maklik is om te volg

Moenie oor u idees in 'n tegniese spesifikasie uitwei nie, want dit mors u tyd en die tyd van u leser. Gebruik so min as moontlik woorde om u idees uit te druk en u gedagtes te organiseer sodat dit maklik is om te volg. Gaan deur u verslag en skakel onnodige bewoording en herhalende sinne uit, sodat u verslag meer direk is.

U kan byvoorbeeld 'Ons sal 'n webwerf skryf waarmee ruiters die gewenste reis kan beplan en die bus kan dophou' na 'Hierdie webwerf laat reisbeplanning en busopsporing toe'

Skryf 'n tegniese spesifikasie Stap 18
Skryf 'n tegniese spesifikasie Stap 18

Stap 4. Kry 'n vennoot om u tegniese spesifikasies na te gaan en terugvoer te gee

Deel u tegniese spesifikasies met 'n spanlid of klasmaat wat dit sal verstaan. Vra hulle om die foute wat hulle sien te merk, en gee u terugvoer oor waar u verbeterings kan aanbring.

Moenie u tegniese spesifikasies wys aan iemand wat u vakgebied nie verstaan nie. Hulle sal waarskynlik verward raak en kan veranderinge aanbeveel wat nie nodig is nie

Skryf 'n tegniese spesifikasie Stap 19
Skryf 'n tegniese spesifikasie Stap 19

Stap 5. Hersien u tegniese spesifikasies indien veranderinge nodig is

Op grond van die terugvoer wat u ontvang het, gaan deur u tegniese spesifikasies en maak hersienings as u voel dat dit nodig is. Konsentreer daarop om die tegniese spesifikasies verstaanbaar te maak vir kliënte en u span. Moenie bekommerd wees dat dit nie perfek is nie.

U sal waarskynlik u tegniese spesifikasies moet opdateer namate u projek of produk vorder. Dit is 'n tydelike dokument, dus moenie toelaat dat dit u verhinder om u werklike werk te verrig nie

Skryf 'n tegniese spesifikasie Stap 20
Skryf 'n tegniese spesifikasie Stap 20

Stap 6. Proeflees u tegniese spesifikasies voordat u dit versprei

Lees u tegniese spesifikasie minstens twee keer deur om na foute te kyk. As u kan, lees dit hardop om u te help om u foute op te spoor. Fokus op dinge soos tikfoute of woorde wat die betekenis van u dokument kan verander.

Soek byvoorbeeld foute soos 'die huidige stelsel is doeltreffend' eerder as 'die huidige stelsel is ondoeltreffend'

Aanbeveel: