Paano Sumulat ng Mga Teknikal na Pagtukoy (na may Mga Larawan)

Talaan ng mga Nilalaman:

Paano Sumulat ng Mga Teknikal na Pagtukoy (na may Mga Larawan)
Paano Sumulat ng Mga Teknikal na Pagtukoy (na may Mga Larawan)

Video: Paano Sumulat ng Mga Teknikal na Pagtukoy (na may Mga Larawan)

Video: Paano Sumulat ng Mga Teknikal na Pagtukoy (na may Mga Larawan)
Video: Pagganyak na Gawain para sa Demo Teaching 2024, Marso
Anonim

Ang isang teknikal na pagtutukoy ay isang dokumento na nagpapaliwanag kung ano ang ginagawa ng isang produkto o proyekto at ipinapakita kung paano makamit ang mga layunin. Kailangan mong ipakilala ang mga customer at ang koponan sa mga problemang nais mong lutasin, ang mga layunin at kinakailangan ng produkto o proyekto. Inilalarawan ng dokumento ang gawaing kailangang gawin at natural na ito ay muling susulat sa buong pagpapatupad ng proyekto.

mga hakbang

Bahagi 1 ng 3: Pagsulat ng Pamagat

Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 1
Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 1

Hakbang 1. Isulat ang pangalan ng proyekto sa unang linya at sa isang sans serif font na laki ng 14 o 16

Ang laki ng font ay dapat na mas malaki upang mas madali itong mabasa at makilala mula sa natitirang teksto. Bigyan ng katwiran ang pamagat o isentro ito.

Ang kumpanya o ang nakahihigit nito ay dapat magbigay ng isang template na nagpapakita kung paano isulat ang headline. Kapag may isang template, sundin lamang ito

Alam mo ba?

Ang mga font ng Sans serif ay walang mga gitling at extension sa mga dulo ng mga tangkay ng sulat, na ginagawang mas moderno ang mga ito. Ang pinakakaraniwang mga halimbawa ay Arial, Calibri at Verdana.

Sumulat ng isang Teknikal na Pagtukoy Hakbang 2
Sumulat ng isang Teknikal na Pagtukoy Hakbang 2

Hakbang 2. Isulat ang petsa sa ibaba ng pangalan ng proyekto na may isang sans serif font na laki ng 12

Laktawan ang isang linya at bawasan ang laki ng font sa 12, ngunit hindi binabago ang font. Ipasok ang petsa sa maginoo na paraan: araw x ng buwan y ng taong z.

  • Kung mayroong isang template, basahin ito upang makuha ang petsa sa tamang format.
  • Napakahalaga ng petsa sapagkat ipapaalam nito sa iyo kung ano ang pinakabagong bersyon ng dokumento.
Sumulat ng isang Teknikal na Pagtukoy Hakbang 3
Sumulat ng isang Teknikal na Pagtukoy Hakbang 3

Hakbang 3. I-type ang “May-akda” at ang pangalan ng may-akda sa ilalim ng petsa

Laktawan ang isa pang linya at isulat ang "May-akda" na sinusundan ng isang colon. Ipasok ang iyong pangalan habang gumagawa ka ng dokumento. Ilagay lamang ang iyong pangalan dito, kahit na ang gawain ay resulta ng isang talakayan sa pangkat.

Ang isang teknikal na pagtutukoy ay dapat palaging mayroong isang solong may-akda, kahit na ito ay isang pagsisikap sa isang koponan. Ang may-akda ay ang taong nagsusulat ng dokumento

Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 4
Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 4

Hakbang 4. Ipasok ang "Koponan" at ang mga pangalan ng mga miyembro ng proyekto

Sa susunod na linya, isulat ang "Koponan" at isang colon. Ilista ang lahat ng mga tao na nagtatrabaho sa proyekto o produkto.

  • Bilang karagdagan sa pagbibigay ng kredito sa mga miyembro ng koponan, ito ay isang paraan ng pagsasabi sa mga tao kung kanino sila dapat pumunta kung mayroon silang mga katanungan tungkol sa pantukoy na panteknikal.
  • Kung nagtrabaho ka lamang sa proyekto, laktawan ang Hakbang na ito.

Bahagi 2 ng 3: Pag-sketch ng Teknikal na Pagtukoy

Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 5
Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 5

Hakbang 1. Sumulat ng isang maikling buod ng proyekto o produkto

Simulan ang dokumento sa isang buod ng iyong ginagawa. Ipasok ang "Buod" bilang pamagat ng seksyon. Ilarawan ang problema, magbigay ng isang pangunahing ideya ng produkto o proyekto at ang pagpapaandar nito. Pagkatapos ay ipaliwanag kung paano mo balak na maabot ang huling layunin at ipakita ang ilang mga detalye. Nabanggit ang mga kaugnay na dokumento sa marketing o engineering at, sa wakas, tantyahin ang oras na kinakailangan upang makumpleto ang produkto o proyekto.

Sumulat ng isang bagay tulad ng: "Ang kasalukuyang sistema ng paglalakbay ay sanhi ng konsentrasyon ng mga pasahero sa dalawang linya at ang underutilization ng pangatlo. Posibleng planuhin sa Internet ang paglalakbay ng dalawang linya lamang ng bus, ngunit ang isa pa ay gumagana pa rin sa mga mapa ng papel at telepono. Ang modelong ito ay nagdudulot ng pagbawas sa bilang ng mga pasahero at pagbawas sa kita ng kumpanya, tulad ng ipinakita sa ulat noong Setyembre 2019. Iminumungkahi naming pagsamahin ang mga kasalukuyang system sa isa lamang na nagpapahintulot sa pag-access sa internet sa tatlong mga linya ng bus. Sa ganitong paraan, ang mga pasahero ay magkakaroon ng isang mas madali at mas mabilis na paraan upang magawa ang paglalakbay at malalaman nang eksakto kung kailan makakarating ang bus sa hintuan. Bilang karagdagan, magagawa nilang mag-ulat ng mga problema nang direkta sa pag-andar sa pakikipag-ugnay."

Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 6
Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 6

Hakbang 2. Gumawa ng isang seksyon ng mga layunin kung hindi sila sakop sa buod

I-type ang "Mga Layunin" bilang pamagat at maikling sabihin kung ano ang nais mong makamit sa proyekto o produkto. Simulan ang teksto sa pamamagitan ng pagpapakilala sa seksyon at banggitin ang mga layunin sa isang itemized o may bilang na listahan.

  • Kung naipakita mo ang mga layunin sa buod, hindi kinakailangan na gawin ang seksyong ito, maliban kung kinakailangan ito ng kumpanya.
  • Sumulat ng isang bagay tulad ng: "Kasama sa bagong sistema ang: 1) isang tool sa pagpaplano ng ruta; 2) isang pag-andar na lokasyon ng heyograpikong lokasyon ng bus; 3) isang paraan para makapag-usap ng mga problema ang mga pasahero."
Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 7
Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 7

Hakbang 3. Isulat ang mga kinakailangan sa produkto sa isang hiwalay na bahagi

I-type ang "Mga Kinakailangan ng Produkto" bilang pamagat at ilarawan kung ano ang kinakailangan upang malutas ang isyu. Gumamit ng isang listahan ng mga paksa at huwag mag-alala tungkol sa pagpapakilala ng seksyon.

Halimbawa: "1) Tinitiyak ng tagaplano ng ruta na ang mga pasahero ay hindi makatuon sa iilang linya lamang; 2) Ang contact box ay isang paraan na nagpapadali sa solusyon ng pag-aalinlangan ng mga pasahero.”

Sumulat ng isang Teknikal na Pagtukoy Hakbang 8
Sumulat ng isang Teknikal na Pagtukoy Hakbang 8

Hakbang 4. Ipaliwanag kung ano ang nasa labas ng saklaw ng proyekto

Pamagatan ang seksyong "Wala sa Saklaw". Huwag magsulat ng mga pambungad na talata, ngunit simpleng listahan ng mga bagay na hindi magagawa upang malutas ang problema, halimbawa, anong trabaho ang hindi magagawa, mga solusyon na isinasaalang-alang mong hindi sapat, at mga tampok na wala ang produkto o proyekto. Maging napaka tiyak upang ang mga mamimili at kawani ay makakakuha ng tamang mensahe.

Sumulat ng katulad nito: “1) Ang bagong sistema ay hindi magbabago ng ruta ng mga linya ng bus; 2) Hindi namin ilalagay ang mga computer o screen sa mga hintuan ng bus, kaya dapat gumamit ang mga pasahero ng kanilang sariling mga mobile device; 3) Hindi namin ginagarantiyahan ang agarang solusyon ng problema lamang sa pagbabago ng system; 4) Ang mga pasahero ay hindi kukunin sa pintuan ng bahay."

Pagpipilian:

karaniwan para sa seksyon na mailagay sa dulo ng panteknikal na detalye at bago ang timeline. Ilagay ito sa pagkakasunud-sunod na nais mo o kung ano ang malinaw na itinuro.

Sumulat ng Teknikal na Pagtukoy ng Hakbang 9
Sumulat ng Teknikal na Pagtukoy ng Hakbang 9

Hakbang 5. Magsama ng isang seksyong "Buksan ang Mga Katanungan" upang talakayin ang mga hindi nalutas na isyu

Ang teknikal na pagtutukoy ay nagpapakita ng isang pangkalahatang-ideya ng produkto o disenyo upang mas mahusay na ipaalam sa mga consumer at gabayan ang koponan patungo sa parehong mga layunin. Huwag magalala tungkol sa pagdaan sa bawat detalye o paglutas ng bawat problema, ngunit lumikha ng isang seksyon na tinatawag na "Buksan ang Mga Isyu" upang ilista ang mga puntong malulutas sa paglaon.

Sumulat, halimbawa: "1) Paano namin hahawakan ang upgrade system? 2) Papalitan ba natin ang mga ruta kung mayroon tayong problema? 3) Ipapakita ba ng system ang impormasyon sa ibang mga wika? 4) Paano kami maglilingkod sa mga pasahero na hindi nakakadalubhasa sa mga bagong teknolohiya?”

Sumulat ng Teknikal na Pagtukoy ng Hakbang 10
Sumulat ng Teknikal na Pagtukoy ng Hakbang 10

Hakbang 6. Ilahad ang plano sa seksyong Diskarte

Pamagatan itong "Plano" o "Diskarte". Ipakita kung paano mo nilalayon na malutas ang mga problema o ang iba't ibang mga diskarte na isinasaalang-alang kung ang proyekto ay nasa maagang yugto. Ilarawan ang pananaliksik at mga uri ng teknolohiya at proseso na ginamit. Kung maaari, magsingit ng mga larawan, grapiko at diagram upang mas madali itong maunawaan ng mga mambabasa. Panghuli, talakayin kung paano mo tatakbo ang mga pagsubok at kung anong aksyon ang iyong gagawin kung may mga problema.

  • Kung kailangan mong ilarawan ang iba't ibang mga diskarte at teknolohiya, lumikha ng isang subseksyon para sa bawat isa.
  • Sumulat ng isang bagay tulad nito: "Makikipagtulungan kami sa koponan sa pagpaplano ng paglalakbay upang lumikha ng isang app na nagpapahintulot sa mga pasahero na pumasok sa kanilang ninanais na patutunguhan at awtomatikong bumuo ng ruta. Maaaring baguhin ng mga gumagamit ang ruta. Nagpapadala ang system ng mga pag-update ng teksto upang matulungan ang mga pasahero na makahanap ng ruta. Isasama namin ang ilang mga customer sa sesyon ng pagsubok na gaganapin bago ilunsad. Kapag may mga problema, gagawin namin ang pagpapanatili sa madaling araw, kapag ang mga bus ay hindi tumatakbo. Bilang karagdagan, magkakaroon kami ng karagdagang sasakyan upang kunin ang mga pasahero na hindi makasakay sa isang bus dahil puno ito."

Pagpipilian:

isama ang isang seksyon na pinangalanang "Paghahanda" upang ibuod ang plano. Karaniwan itong opsyonal.

Sumulat ng isang Teknikal na Pagtukoy Hakbang 11
Sumulat ng isang Teknikal na Pagtukoy Hakbang 11

Hakbang 7. Pag-usapan ang tungkol sa mga pagpipilian na isinasaalang-alang ngunit sa kalaunan ay itinapon

Ilagay ang nilalamang ito bilang isang substep ng plano o sa dulo ng dokumento at bago ang timeline. Sumulat sa ilalim ng pamagat na "Mga alternatibong isinasaalang-alang" at ilarawan ang mga ito. Ipaliwanag kung bakit mo itinapon ang bawat pagpipilian.

Isulat ito nang ganito: "Isinasaalang-alang namin ang posibilidad ng paggamit ng mga color map na may mga alamat na mas mura, ngunit walang magandang pagtanggap sa mga pasahero at nalilito ang test group."

Sumulat ng Teknikal na Pagtukoy ng Hakbang 12
Sumulat ng Teknikal na Pagtukoy ng Hakbang 12

Hakbang 8. Ilarawan ang mga pamamaraan ng pagsukat ng produkto o proyekto

Ilagay ang nilalaman sa isa o maraming mga seksyon. Lagyan ng label ito ng "Pagsukat ng epekto", "Pagsusuri" o "Mga Pagsukat". Ipaliwanag sa isang talata o dalawa kung paano mo matiyak na gumagana ito nang tama at nakakamit ang mga layunin. Gayundin, ilarawan kung paano suriin ang mga error at problema.

  • Pag-usapan ang tungkol sa mga proseso ng pagsusuri at mga teknolohiya na gagamitin.
  • Sabihin ang isang bagay tulad ng: Bilang karagdagan, magsasagawa kami ng isang survey sa mga pasahero upang masuri ang antas ng kasiyahan at makilala ang mga problema."
Sumulat ng Teknikal na Pagtukoy Hakbang 13
Sumulat ng Teknikal na Pagtukoy Hakbang 13

Hakbang 9. Ipakita kung paano mo mapangalagaan ang seguridad at privacy

Isulat ang pamagat na "Seguridad at Privacy" at ipaliwanag kung paano mo protektahan ang mga gumagamit mula sa mga digital na atake. Ilarawan ang mga panganib at mekanismo ng proteksyon sa privacy sa ilang mga talata.

  • Palaging may mga panganib at problema, kaya huwag sabihin na wala sila.
  • Isulat ito tulad nito: "Ang mga gumagamit ay nagbibigay ng kasalukuyang lokasyon at address ng bahay. Maaari silang lumikha ng isang profile at mai-save ang kanilang kasaysayan ng paglalakbay. Gumagamit kami ng mga pamamaraan ng pag-encrypt at isang firewall upang maprotektahan ang data."
Sumulat ng Teknikal na Pagtukoy ng Hakbang 14
Sumulat ng Teknikal na Pagtukoy ng Hakbang 14

Hakbang 10. Tapusin ang dokumento sa isang timeline at isang listahan ng mga timestamp

Ang timeline ay isang mahalagang tool upang mapanatili ang proyekto sa track at maipakita sa iyo nang eksakto kung ano ang kailangang gawin at kailan. Pamagat ito ng "Timeline" at hatiin ang mga gawain. Gumawa ng isang listahan ng mga paksa para sa bawat koponan o miyembro.

  • Halimbawa, ang paghahati ng mga gawain ay maaaring isama ang "Koponan sa engineering", "Koponan sa pagpaplano", "Marketing" at "Kaligtasan ng kalidad".
  • Ang listahan ng dapat gawin para sa pangkat ng engineering ay maaaring may mga item tulad ng: "1) Bumuo ng isang pag-update para sa site; 2) Sumulat ng isang app ng pagpaplano ng paglalakbay; 3) Mag-program ng isang contact system."

Bahagi 3 ng 3: Pagtatapos sa pagtutukoy ng teknikal

Sumulat ng Teknikal na Pagtukoy ng Hakbang 15
Sumulat ng Teknikal na Pagtukoy ng Hakbang 15

Hakbang 1. Gumamit ng solong puwang sa dokumento at laktawan ang isang linya sa pagitan ng mga seksyon

Binabawasan ng solong espasyo ang laki ng pantukoy na panteknikal at ginagawang mas madaling manipulahin ang dokumento. Kapag binabago ang mga talata o seksyon, laktawan lamang ang isang linya upang hindi magdagdag ng mga hindi kinakailangang puwang.

Posibleng magbigay ang samahan ng mga tiyak na tagubilin sa pag-format. Kung gayon, sundin ang mga ito

Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 16
Sumulat ng isang Teknikal na Pagtukoy ng Hakbang 16

Hakbang 2. Gumamit ng pangalawang panghalip na panghalip sa pangalawang tao sa dokumento

Habang tinatalakay mo ang gawaing magagawa mo at ng iyong koponan, laging gamitin ang "kami". Kapag binabanggit ang isang tukoy na koponan o tao, isama ang buong pangalan upang ang sanggunian ay malinaw. Sa ganoong paraan gagawin mong mas layunin ang pagtutukoy ng teknikal.

  • Halimbawa, mas mahusay na isulat ang "Kami ay mag-a-update ng mga pagtutukoy kung kinakailangan" kaysa sa "Ang mga pagtutukoy ay maa-update kung kinakailangan".
  • Katulad nito, sabihin na "Ang pangkat ng engineering ay magtatayo ng site" o "Marta de Sousa ay responsable para sa pagtukoy sa plano sa marketing".
Sumulat ng Teknikal na Pagtukoy ng Hakbang 17
Sumulat ng Teknikal na Pagtukoy ng Hakbang 17

Hakbang 3. Gumamit ng malinaw, maigsi at madaling maunawaan na wika

Huwag maging buli ang mga pangungusap at ideya sa ganitong uri ng dokumento sapagkat nasasayang lamang ang iyong oras at ang mambabasa. Gumamit ng ilang mga salita hangga't maaari upang maipahayag ang mga ideya sa isang didactic na paraan. Suriin ang ulat at alisin ang lahat ng hindi kinakailangang mga salita at paulit-ulit na parirala.

Halimbawa, baguhin ang "Gagawa kami ng isang website na nagbibigay-daan sa mga pasahero na magplano ng mga paglalakbay at subaybayan ang landas ng bus" sa "Papayagan ng website na magplano ng mga paglalakbay at subaybayan ang daanan ng bus"

Sumulat ng Teknikal na Pagtukoy ng Hakbang 18
Sumulat ng Teknikal na Pagtukoy ng Hakbang 18

Hakbang 4. Hilingin sa isang katrabaho na suriin ang dokumento at magbigay ng mga mungkahi o pagpuna

Ibahagi ang teknikal na pagtutukoy sa mga miyembro ng koponan. Hilingin sa kanila na markahan ang mga error at magmungkahi ng mga pagpapabuti.

Huwag ipakita ang dokumento sa isang tao sa labas ng patlang, dahil maaaring hindi maunawaan ng tao ang mga bagay na simple para sa mga eksperto at inirerekumenda ang mga hindi kinakailangang pagbabago

Sumulat ng Teknikal na Pagtukoy Hakbang 19
Sumulat ng Teknikal na Pagtukoy Hakbang 19

Hakbang 5. Suriin ang dokumento kung kailangan mong baguhin ito

Isaalang-alang ang mga mungkahi at pagpuna sa muling pagbabasa ng panteknikal na detalye. Ang pinakamahalaga ay madali para maunawaan ng mga customer at miyembro ng koponan. Gayunpaman, huwag mag-alala tungkol sa paggawa ng isang bagay na perpekto.

Malamang na kakailanganin mong i-update ang panteknikal na detalye sa buong proyekto o pag-unlad ng produkto. Ito ay isang pansamantalang dokumento, kaya huwag mabitin sa kung ano ang sinasabi nito

Sumulat ng Teknikal na Pagtukoy Hakbang 20
Sumulat ng Teknikal na Pagtukoy Hakbang 20

Hakbang 6. Gumawa ng isang magandang pagsusuri bago ipamahagi ang dokumento

Basahin ito nang hindi bababa sa dalawang beses at, kung maaari, malakas. Magbigay ng higit na pansin sa mga typo at kahulugan ng salita.

Halimbawa, mag-ingat sa pagbabago ng "ang kasalukuyang sistema ay hindi mabisa" sa "ang kasalukuyang sistema ay mabisa"

Inirerekumendang: