Að skrifa betri verklýsingar

Höfundur: Peter Berry
Sköpunardag: 20 Júlí 2021
Uppfærsludagsetning: 13 Maint. 2024
Anonim
Að skrifa betri verklýsingar - Skapandi
Að skrifa betri verklýsingar - Skapandi

Efni.

Sérstakur, ásamt því að prófa og stjórna dreifingu, eru tímakörfur. Þeir gleypa daga í lífi verkefnisins og gera ekki það sem þeir lofa.

En þeirra er þörf. Hvort sem þig vantar stuttan stutta stund eða eitthvað til að kvitta með yfirmanni markaðssetningarinnar, þá hefur skjal sem þú og teymið raunverulega geta notað dag frá degi heldur verkefninu skriðþunga.

Við tókum þennan haus. Við fórum yfir allar sérstakar upplýsingar sem við höfðum. Við fjarlægðum allt hróp. Við komumst að því að sérstakar upplýsingar geta verið eins samvinnuhæfar og forritið sem þú smíðar.

Þarftu meira að segja sérstakan?

Upplýsingar eru lélegar lýsingar á því hvernig raunverulegur heimur gæti verið. Þeir eru flýtileiðir til að smíða vinnandi hlut, svo eins og 37 merki hafa sagt í mörg ár er alltaf betra að hafa virkan kóða sem hægt er að laga.

Stundum er léleg lýsing öruggari en dýrt spott, en ekki láta það henda þér aftur í að framleiða 100 blaðsíðna skjöl sem allir vilja brenna.

Í umboðsskrifstofu, þar sem þú vinnur saman á milli teyma, fyrirtækja, tímabeltis og landa, getur verið ómögulegt að fá samþykkta áætlun. Það síðasta sem þú þarft úr sérstakri tækni er eitthvað sem eyðir helmingi áreynslu liðsins áður en það byrjar jafnvel að þróa.

Svo, já. Forðastu sérstakur hvenær sem þú getur en þegar þú þarft að skrifa einn, hvernig heldurðu því að það sé grannt?


Hver er tilgangurinn með sérstökum?

Við skulum byrja á því hver forskriftin er. Þó að það séu margar og mismunandi hugmyndir um hvernig eigi að skrifa sérstakar upplýsingar eða jafnvel hvers vegna, þá þurfa allir sem starfa á stofnun eða teymi að spyrja spurningarinnar:

  • Hvað er þetta og hvað átti að gera?

Og þá munu þeir spyrja:

  • Hvernig geri ég mitt til að láta það gera hlutina sem það átti að gera?

Verum enn útópískari.

Sérstakar upplýsingar geta ekki verið erfiðar að skrifa og ekki erfitt að lesa. Ef þeir eru það munu þeir sem skrifa eða lesa þá eyða orku í að koma höfðinu í snið frekar en verkefnið.

Sérstakar upplýsingar ættu ekki að vera stærri en þær þurfa að vera. Hentu útgáfusögunni og hvaða inngangi sem er.

Sérstakar upplýsingar geta ekki verið óljósar eða skuldbindandi. Ef þú hefur almenna hugmynd en hefur ekki nákvæma áætlun um hvernig henni verður hrint í framkvæmd, þá hefurðu spurningu, ekki sérstakan. Vera heiðarlegur.

Við ættum að hafa léttara skjal sem er auðveldara að lesa og skrifa og eitt sem er heiðarlegra. Og gagnlegt.


Hvernig sértæki líta út þessa dagana ...

Það er draumur okkar útópista en hvernig eru hlutirnir núna?

Gremjan sem rak mig til að henda út eins og við gerðum sérstakar upplýsingar og sannfæra viðskiptavini okkar um að fylgja í kjölfarið kom frá átökunum, hálflesnu skjölunum sem virtust aðallega skrifuð til að láta rithöfundinum líða vel en að hjálpa lesandanum að gera eitthvað.

Í iðnaði þar sem samskipti eru allt og fólk skrifar fyrir lesandann allan tímann kemur það á óvart að svo fáir geti skrifað fyrir teymi verktaka og hönnuða.

Flest verkefni byrja á Venn skýringarmynd yfir eigin hagsmuni. Hver hluti liðsins skrifar skjöl sín, annaðhvort vísar til annarra skjala eða ber ábyrgð.

Sérstök viðskiptastig er frá nokkrum setningum að markmiðum fyrirtækisins með verkefnið. Markaðssetningin byrjar með markmið umbreytinga, aukinna heimsókna eða breytinga á vörumerkinu. Svo er það hagnýtur sérstakur, IA, hönnunin og tækniforskriftirnar.

Hver þessara svara svörum við nokkrum spurningum, vekur upp aðra en engin þeirra er fullmikil vegna þess að þau vísa hvert til annars. Til dæmis „þetta verður útfært í hönnuninni“ eða „tækniforskriftirnar munu bæta við fleiri smáatriðum hér“ og „uppbygging TBC í IA skjölunum“.

Bætt við tölvupóstinn, viðhengi, Basecamp þræði, Google skjöl, gists á Github og fleira gerir það að verkum að upprunalega ásetningurinn er óraunhæfur. Svo að fólk gerir það ekki. Þeir giska best eða vinna út frá skjalinu sem þeir hafa og þá fara hlutirnir úrskeiðis.

Að lokum er vandamálið við hverja af forskriftunum og stuttmyndunum að þær eru ekki uppfærðar. Þegar verktaki gerir sér grein fyrir að eitthvað verður að gera öðruvísi, eða hönnuðurinn lagfærir hönnunina, nennum við ekki að uppfæra skjalið svo það verði í besta falli gagnslaust og í versta falli skaðlegt þeim sem byrja á verkefninu.

Þetta hljómar eins og inngangur að þungu forskriftarsniði, hundruð blaðsíðna þykkt með 20 viðaukum. Það er það ekki. Við verðum samt að hafa sniðið mjótt og hagnýtt.


Hvað skyldi það vera?

Rétt eins og að smíða forrit sem þarfnast afritunar, færir JSON frá nýju API, framkóðun og innfædd forritun að tæknin ætti ekki að vera lén aðeins eins manns. Vinna saman að tækninni, ekki bara vörunni.

Næst skaltu halda í eitt heimildarskjal sem allir breyta í gegnum verkefnið. Þetta er villutrú verkefnastjórnunar og ég veit að ég er ekki í góðum félagsskap. Hvort heldur sem er ...

Búum til þetta skjal og setjum það upp á Dropbox. Google skjöl eða annar samstarfsstaður er í lagi, en ekki láta verkefnisstjórann hafa eina eintakið hvenær sem er.

Nú þurfum við snið sem er uppbyggt en þarf næstum núll sekúndur til að skilja. Við greindum margra ára sérstakar, stuttbækur, hönnun og víramma og eimaði þeim í: UX, innihaldsstjórnun, útfærslu og spurningar. Og mynd.

Byrjaðu á mynd. Á hverri síðu er mynd í miðjunni. Krot frá upphafsfundinum (sem er líklega nákvæmari mynd af verkefninu), vírramma eða hönnunarspotta. Láttu hverja síðu vera sem sögu og sýndu okkur hvað notandinn mun sjá þegar hann lifir þá sögu.

UX fjallar um það sem hluturinn gerir fyrir hvern notanda. Efnið sem birtist á síðunni, hvernig myndbandið rennur inn, hvaða upplýsingar notandinn getur fundið. Þetta er dæmigert í víramma IA og í hagnýtum tækniforskriftum, svo er það oft skrifað af ÚA eða verkefnastjórum.

Efnisstjórnun lýsir því hvernig notendur fyrirtækisins geta breytt innihaldi á síðunni. Útfærsla er þar sem tækniforskriftin, kóðatilvísanir og API skýringar fara. Þó að lén kóðara haldi hugmyndir og frumgerðir áfram í gegnum verkefnið með því að deila því.

Að lokum spurningar. Allt sem er óákveðið eða óljóst fer hér. Þú verður að vera strangur. Fyrsta synd margra stuttbuxna og hagnýtrar forskriftir er að þær lesa eins og söluskjöl.

„Ritstjórar efnisins geta breytt hvaða hluta heimasíðunnar sem er.“

Nei, þeir gera það ekki. Þeir munu líklega geta kynnt nokkrar fréttir og breytt borða, svo segðu það.

"Bókunarformin verða útfærð með því fyrirliggjandi bókunarkerfi. Hönnun TBC."

Hljómar eins og spurning: „Fáðu Dean til að skoða hönnunarmöguleika bókunarkerfisins og gera hönnun“. Vertu hagnýt.

Að vera heiðarlegur gagnvart spurningum gerir tvennt: þú ert heiðarlegri varðandi ófullnægjandi forskriftina (með öðrum orðum það eru ennþá spurningar fyrir stærstan hluta verkefnisins) og þú getur deilt byrðinni við að svara þeim vegna þess að aðrir í teyminu geta séð hvað þarf að ákveða.

Hafðu það satt, jafnvel þegar sannleikurinn breytist

Sérstakar upplýsingar sem ekki eru uppfærðar deyja, svo haltu lífi þínu með því að uppfæra myndirnar í tækninni með því sem best endurspeglar raunveruleikann.

Ef þú byrjaðir með skissu, uppfærðu þetta með einhverju öðru þegar það er eitthvað bætir við upplýsingum. Forðast tilgangslausa og dýra viðleitni við að endurvinna allar blaðsíður frá stuttum til hagnýtra forskriftar, víramma og síðan hönnun.

Alltaf þegar betri framsetning er á fyrirætlunum þínum skaltu skipta um gamla fulltrúa strax. Skiptu um skissu fyrir hönnun og notaðu skissuna aldrei aftur og þú munt forðast spurninguna „hvaða útgáfa er rétt“.

Svona notum við þetta á núverandi síðu:

Er þetta allt og sumt?

Allt sem við höfum gert er að láta liðið vinna fyrr saman. Í stað Venn skýringarmyndar um forskriftarstríð, vinnum við saman strax í upphafi og vísa til og uppfæra eitt.

Sérstakar upplýsingar sem UX sérfræðingar, IA og hönnuðir framleiða eru sameinaðir þróunarnótunum til að halda einni hugmynd um sannleikann í gegnum verkefnið. Og þegar fullbúnar síður eða app endurspegla það sem við viljum notarðu þær í staðinn.

Ekki halda á dogmatískan hátt að Visio, Photoshop eða copy sé best.

Margt af því sem hér er gert er gert af sprotafyrirtækjum og Agile teymum, en umboðsskrifstofur ættu að vera staðfastar með bestu leiðina til að tilgreina verkefni.

Öfgafullt, við styttum þróunartímann úr vikum í nokkra daga og skárum út daga af forskrift sem varð til þess að verkefnastjóri hataði verkefnið.

Þetta verður ekki silfurskot, en hver vill ekki fá tækifæri til að forðast að lesa aðra 50 blaðsíðna lýsingu á því hvernig blogg virkar?

„Specification“ mynd frá Bigstock.

Veldu Stjórnun
Hvernig hönnuðir vinna: Matt Needle talar um súrrealisma og fineliners
Lestu Meira

Hvernig hönnuðir vinna: Matt Needle talar um súrrealisma og fineliners

Matt Needle hóf jálf tætt tarf árið 2007 og hefur íðan unnið með mörgum áberandi við kiptavinum ein og Nike, The Big Chill Fe tival (í ...
10 hönnunarhugtök sem hver vefhönnuður þarf að kunna
Lestu Meira

10 hönnunarhugtök sem hver vefhönnuður þarf að kunna

Undanfarin ár hef ég verið að kenna vinnu tofu um grunnatriði jónrænnar hönnunar em miða að forriturum. Ein og með fle ta hluti á vefnum, he...
Adobe lofar Blink og fjölbreytileika vafra
Lestu Meira

Adobe lofar Blink og fjölbreytileika vafra

Verkfræði tofu tjóri Adobe Web Platform, Vincent Hardy, hefur agt að hann telji að Blink-verkefni Google muni gagna t vefnum þrátt fyrir ótta um að þa...