Conţinut

• Pași
• sfaturi

Specificația tehnică este un document care explică ce face un produs sau proiect și arată cum să atingă obiectivele. Trebuie să prezentați consumatorilor și personalului problemele pe care intenționați să le rezolvați, obiectivele și cerințele produsului sau proiectului. Documentul descrie lucrările care trebuie făcute și este firesc ca acesta să fie rescris în timpul executării proiectului.

Pași

Partea 1 din 3: Scrierea titlului

1. 

   Scrieți numele proiectului pe prima linie și într-un font sans serif de 14 sau 16. Dimensiunea fontului trebuie să fie mai mare pentru a ușura citirea și a se distinge de restul textului. Justificați titlul sau centrați-l.
   • Compania sau superiorul acesteia trebuie să furnizeze un șablon care să arate cum să scrie titlul. Când există un model, pur și simplu urmați-l.

   Știați? Fonturile Sans serif nu au linii și extensii la capetele tulpinilor literei, lăsându-le cu un aspect mai modern. Cele mai frecvente exemple sunt Arial, Calibri și Verdana.

   
   

2. 

   Scrieți data sub numele proiectului cu un font pe 12 fețe. Săriți o linie și micșorați dimensiunea fontului la 12, dar fără a modifica fontul. Introduceți data în mod convențional: ziua x a lunii y a anului z.
   • Dacă există un șablon, citiți-l pentru a lăsa data în formatul corect.
   • Data este foarte importantă, deoarece vă permite să cunoașteți cea mai recentă versiune a documentului.

3. 

   
   
   Tastați „Autor” și numele autorului sub dată. Săriți o altă linie și scrieți „Autor”, urmat de două puncte. Introduceți numele dvs., pe măsură ce produceți documentul. Doar puneți-vă numele, chiar dacă lucrarea este rezultatul unei discuții de grup.
   • O specificație tehnică trebuie să aibă întotdeauna un singur autor, chiar și atunci când vine vorba de lucrul în echipă. Autorul este persoana care scrie documentul.

4. 

   
   
   Tastați „Echipa” și numele membrilor proiectului. Pe rândul următor, scrieți „Echipa” și două puncte. Menționează pe toți cei care lucrează la proiect sau produs.
   • Pe lângă acordarea creditului cuvenit membrilor echipei, este o modalitate de a le spune oamenilor pe cine să caute dacă au întrebări cu privire la specificațiile tehnice.
   • Dacă ați lucrat singur la proiect, săriți peste acest pas.

Partea 2 din 3: Schițarea specificațiilor tehnice

1. 

   Scrieți un scurt rezumat al proiectului sau produsului. Porniți documentul cu un rezumat al ceea ce faceți. Tastați „Rezumat” ca titlu al secțiunii. Descrieți problema, dați o idee de bază despre produs sau proiect și funcția acestuia. Apoi explicați cum intenționați să atingeți obiectivul final și arătați câteva detalii. Menționați documentele relevante de marketing sau inginerie și, în cele din urmă, dați o estimare a timpului necesar pentru finalizarea produsului sau proiectului.
   • Scrieți ceva de genul: „Sistemul actual de călătorie determină concentrarea pasagerilor pe două linii și subutilizarea celei de-a treia. Este posibil să planificați pe internet călătoria a doar două linii de autobuz, dar cealaltă funcționează în continuare cu hărți de hârtie și telefon. Acest model determină o reducere a numărului de pasageri și o scădere a veniturilor companiei, după cum se arată în raportul din septembrie 2019. Propunem să îmbinăm sistemele actuale într-unul singur care permite accesul la internet la cele trei linii de autobuz. În acest fel, pasagerii vor avea un mod mai ușor și mai agil de a-și face călătoria și vor ști exact când va ajunge autobuzul la punctul respectiv. În plus, pot raporta probleme direct cu funcția Intrați în legătură.”

2. 

   Faceți o secțiune de obiective dacă nu au fost acoperite în rezumat. Tastați „Obiective” ca titlu și spuneți pe scurt ce doriți să realizați cu proiectul sau produsul. Porniți textul introducând secțiunea și menționați obiectivele într-o listă detaliată sau numerotată.
   • Dacă ați prezentat obiectivele în rezumat, nu este necesar să faceți această secțiune, cu excepția cazului în care compania o cere.
   • Scrieți ceva de genul: „Noul sistem include: 1) un instrument de planificare a rutei; 2) o funcție de localizare geografică a autobuzului; 3) o modalitate prin care pasagerii pot raporta probleme. ”

3. 

   Scrieți cerințele produsului într-o parte separată. Introduceți „Cerințe despre produs” ca titlu și descrieți ce este necesar pentru a rezolva problema. Folosiți o listă de subiecte și nu vă faceți griji cu privire la introducerea secțiunii.
   • De exemplu: „1) Planificatorul de traseu se asigură că pasagerii nu se vor concentra pe doar câteva linii; 2) Caseta de contact este un mijloc care facilitează soluționarea îndoielilor pasagerilor. ”

4. 

   Explicați ce se află în afara scopului proiectului. Dați titlul secțiunii „În afara domeniului de aplicare”. Nu scrieți paragrafe introductive, ci pur și simplu o listă de lucruri care nu vor fi făcute pentru a rezolva problema, de exemplu, ce muncă nu se va face, soluțiile pe care le considerați inadecvate și caracteristicile pe care produsul sau proiectul nu le are. Fiți foarte specific, astfel încât consumatorii și personalul să înțeleagă corect mesajul.
   • Scrieți așa ceva: „1) Noul sistem nu va schimba traseul liniilor de autobuz; 2) Nu vom pune computere sau ecrane la stațiile de autobuz, astfel încât pasagerii trebuie să își folosească propriile dispozitive mobile; 3) Nu garantăm soluția imediată a problemei doar prin schimbarea sistemului; 4) Pasagerii nu vor fi prinși la ușă. ”

   Opțiune: este obișnuit ca secțiunea să fie plasată la sfârșitul specificațiilor tehnice și înainte de cronologie. Puneți-l în ordinea dorită sau în ceea ce este instruit în mod expres.

5. 

   Includeți o secțiune „Întrebări deschise” pentru a discuta problemele care încă nu au fost rezolvate. Specificația tehnică oferă o imagine de ansamblu asupra produsului sau proiectului pentru a informa mai bine consumatorii și a conduce echipa către aceleași obiective. Nu vă faceți griji dacă vorbiți despre toate detaliile sau rezolvați toate problemele, dar creați o secțiune numită „Întrebări deschise” pentru a enumera punctele care vor fi rezolvate ulterior.
   • Scrieți, de exemplu: „1) Cum vom gestiona sistemul de actualizare? 2) Vom schimba căile dacă avem o problemă? 3) Va afișa sistemul informații în alte limbi? 4) Cum vom servi pasagerii care nu stăpânesc noile tehnologii? ”

6. 

   Prezentați planul în secțiune Abordare. Dați titlul „Plan” sau „Abordare”. Arătați cum intenționați să rezolvați problemele sau diferitele abordări care sunt luate în considerare, dacă proiectul se află în etapele inițiale. Descrieți cercetarea și tipurile de tehnologii și procese utilizate. Dacă este posibil, introduceți imagini, grafice și diagrame pentru a ușura înțelegerea cititorilor. În cele din urmă, discutați cum veți efectua testele și ce pași veți lua dacă există probleme.
   • Dacă trebuie să descrieți abordări și tehnologii diferite, creați o subsecțiune pentru fiecare.
   • Scrieți așa ceva: „Vom colabora cu echipa de planificare a călătoriilor pentru a crea o aplicație care să permită pasagerilor să intre în destinația dorită și să gestioneze automat ruta. Utilizatorii pot schimba ruta. Sistemul trimite actualizări text pentru a ajuta pasagerii să-și găsească ruta. Vom include unii clienți în sesiunea de testare care va avea loc înainte de lansare. Când sunt probleme, vom face întreținerea în zori, când autobuzele nu circulă. În plus, vom avea un vehicul suplimentar pentru a prelua pasagerii care nu au putut urca într-un autobuz, deoarece era plin. ”

   Opțiune: includeți o secțiune intitulată „Pregătiri” pentru a rezuma planul. De obicei este opțional.

7. 

   Vorbiți despre opțiunile care au fost luate în considerare, dar au ajuns să fie eliminate. Plasați acest conținut ca o etapă secundară a planului sau la sfârșitul documentului și înainte de cronologie. Scrieți titlul „Alternative luate în considerare” și descrieți-le. Explicați de ce ați eliminat fiecare opțiune.
   • Scrieți astfel: „Ne-am gândit să folosim hărți color cu subtitrări pentru a le face mai ieftine, dar a fost puțină acceptare în rândul pasagerilor și grupul de testare a fost confuz.”

8. 

   Descrieți metodele și măsurătorile de evaluare a produsului sau a proiectului. Plasați conținutul în una sau mai multe secțiuni. Dați titlul „Măsurarea impactului”, „Evaluare” sau „Măsurători”. Explicați într-unul sau două paragrafe cum veți asigura funcționarea corectă și atingerea obiectivelor. De asemenea, descrieți cum să verificați erorile și problemele.
   • Vorbiți despre procesele de analiză și tehnologiile care vor fi utilizate.
   • Spuneți ceva de genul: „Vom face comparații între timpul estimat al rutelor și ruta reală pentru a asigura respectarea orarelor. În plus, vom efectua un sondaj cu pasagerii pentru a evalua nivelul lor de satisfacție și a identifica problemele. ”

9. 

   Arătați cum veți păstra securitatea și confidențialitatea. Scrieți titlul „Securitate și confidențialitate” și explicați cum veți proteja utilizatorii de atacurile digitale. Descrieți riscurile și mecanismele de protecție a vieții private în câteva paragrafe.
   • Există întotdeauna riscuri și probleme, așa că nu spuneți niciodată că nu există.
   • Scrieți astfel: „Utilizatorii furnizează locația curentă și adresa de domiciliu. Aceștia își pot crea un profil și își pot salva istoricul de călătorie. Vom folosi metode de criptare și un firewall pentru a proteja datele. ”

10. 

    Finalizați documentul cu o cronologie și o listă de marcaje temporale. Cronologia este un instrument important pentru a menține proiectul pe drumul cel bun și pentru a arăta exact ce trebuie făcut și când. Dați titlul „Cronologie” și împărțiți sarcinile. Faceți o listă de subiecte pentru fiecare echipă sau membru.
    • De exemplu, împărțirea sarcinilor poate include „Echipa de ingineri”, „Echipa de planificare”, „Marketing” și „Asigurarea calității”.
    • Lista de sarcini pentru echipa de ingineri poate avea elemente precum: „1) Dezvoltarea unei actualizări pentru site-ul web; 2) Scrieți o cerere de planificare a călătoriilor; 3) Programați un sistem de contact. ”

Partea 3 din 3: Finalizarea specificațiilor tehnice

1. 

   Utilizați spațiul unic din document și săriți o linie între secțiuni. Spațiul unic reduce dimensiunea specificațiilor tehnice și facilitează manipularea documentului. Când schimbați paragrafe sau secțiuni, trebuie doar să omiteți o linie pentru a evita adăugarea de spații inutile.
   • Este posibil ca organizația să ofere instrucțiuni specifice privind formatarea. Dacă da, urmează-le.

2. 

   Folosiți pronumele de persoană a doua plural din document. Pe măsură ce discutați despre munca care va fi făcută de dvs. și de echipa dvs., folosiți întotdeauna „noi”. Când menționați o anumită echipă sau persoană, includeți numele complet pentru a clarifica referința. Deci, faceți specificațiile tehnice mai obiective.
   • De exemplu, este mai bine să scrieți „Vom actualiza specificațiile după cum este necesar” decât „Specificațiile vor fi actualizate după cum este necesar”.
   • În mod similar, spuneți „Echipa de ingineri va crea site-ul web” sau „Marta de Sousa va fi responsabilă pentru definirea planului de marketing”.

3. 

   Utilizați un limbaj clar, concis și ușor de înțeles. Nu continuați să lustruiți frazele și ideile din acest tip de document, deoarece vă servește doar pentru a vă pierde timpul și cititorul. Folosiți cât mai puține cuvinte pentru a exprima ideile într-un mod didactic. Examinați raportul și eliminați toate cuvintele inutile și frazele repetitive.
   • De exemplu, transformați „Vom realiza un site web care să permită pasagerilor să planifice călătorii și să monitorizeze calea autobuzului” în „Site-ul vă va permite să planificați călătoriile și să monitorizați ruta autobuzului”.

4. 

   Rugați un coleg de serviciu să revizuiască documentul și să facă sugestii sau critici. Distribuiți specificațiile tehnice membrilor echipei. Rugați-i să marcheze erori și să sugere îmbunătățiri.
   • Nu arătați documentul cuiva din afara domeniului, deoarece persoana respectivă nu poate înțelege lucruri simple pentru experți și recomandă modificări inutile.

5. 

   Examinați documentul dacă trebuie să îl modificați. Luați în considerare sugestiile și criticile atunci când recitiți specificațiile tehnice. Ceea ce contează cel mai mult este că este ușor de înțeles pentru clienți și membrii echipei. Cu toate acestea, nu vă faceți griji cu privire la a face ceva perfect.
   • Este probabil că va trebui să actualizați specificațiile tehnice pe tot parcursul dezvoltării proiectului sau produsului. Este un document temporar, deci nu vă blocați cu ceea ce scrie.

6. 

   Faceți o analiză bună înainte de a distribui documentul. Citiți-l cel puțin de două ori și, dacă este posibil, cu voce tare. Acordați o atenție mai mare greșelilor de tipar și semnificației cuvintelor.
   • De exemplu, aveți grijă să schimbați „sistemul actual este ineficient” în „sistemul actual este eficient”.

sfaturi

• Poate că compania vă va cere să scrieți secțiuni specifice. Respectați toate cerințele, chiar dacă constă doar în schimbarea titlurilor.