Съдържание

• Стъпки
• Съвети

Техническата спецификация е документ, който обяснява какво прави продукт или проект и показва как да се постигнат целите. Трябва да представите на потребителите и персонала проблемите, които възнамерявате да разрешите, целите и изискванията на продукта или проекта. Документът описва работата, която трябва да бъде извършена и е естествено, че тя ще бъде пренаписана по време на изпълнението на проекта.

Стъпки

Част 1 от 3: Писане на заглавието

1. 

   Напишете името на проекта на първия ред и с 14 или 16 sans serif шрифт. Размерът на шрифта трябва да е по-голям, за да се улесни четенето и да се откроява от останалия текст. Обосновете заглавието или го центрирайте.
   • Компанията или нейният началник трябва да предоставят шаблон, който показва как да напишете заглавието. Когато даден модел съществува, просто го следвайте.

   Знаеше ли? Безсерифните шрифтове нямат щрихите и разширенията в краищата на буквените стъбла, оставяйки ги с по-модерен вид. Най-често срещаните примери са Arial, Calibri и Verdana.

   
   

2. 

   Напишете датата под името на проекта с 12-странен шрифт. Пропуснете ред и намалете размера на шрифта до 12, но без да променяте шрифта. Въведете датата по конвенционалния начин: ден x от месец y от година z.
   • Ако има шаблон, прочетете го, за да оставите датата в правилния формат.
   • Датата е много важна, защото ви позволява да знаете най-новата версия на документа.

3. 

   
   
   Въведете "Автор" и името на автора под датата. Пропуснете друг ред и напишете "Автор", последван от двоеточие. Въведете името си, докато създавате документа. Просто посочете името си, дори ако работата е резултат от групова дискусия.
   • Техническата спецификация винаги трябва да има един автор, дори когато става въпрос за работа в екип. Авторът е човекът, който пише документа.

4. 

   
   
   Въведете "Екип" и имената на членовете на проекта. На следващия ред напишете "Екип" и двоеточие. Споменете всички, които работят по проекта или продукта.
   • В допълнение към отдаването на дължимото признание на членовете на екипа, това е начин да се каже на хората, които да търсят, ако имат въпроси относно техническата спецификация.
   • Ако сте работили сами по проекта, пропуснете тази стъпка.

Част 2 от 3: Скициране на техническата спецификация

1. 

   Напишете кратко резюме на проекта или продукта. Започнете документа с обобщение на това, което правите. Въведете "Резюме" като заглавие на раздела. Опишете проблема, дайте основна представа за продукта или проекта и неговата функция. След това обяснете как възнамерявате да постигнете крайната цел и покажете някои подробности. Споменете съответните маркетингови или инженерни документи и накрая дайте оценка на времето, необходимо за финализиране на продукта или проекта.
   • Напишете нещо като: „Настоящата система за пътуване причинява концентрация на пътниците на две линии и недостатъчно използване на третата. Възможно е в интернет да се планира пътуването само на две автобусни линии, но другата все още работи с хартиени карти и телефон. Този модел причинява намаляване на броя на пътниците и намаляване на приходите на компанията, както е показано в доклада от септември 2019 г. Предлагаме да обединим сегашните системи в само една, която позволява достъп до интернет до трите автобусни линии. По този начин пътниците ще имат по-лесен и пъргав начин за пътуване и ще знаят кога точно автобусът ще пристигне до точката. Освен това те могат да съобщават за проблеми директно с функцията свържете се.”

2. 

   Направете раздел на целите, ако те не са били включени в резюмето. Въведете „Цели“ като заглавие и накратко кажете какво искате да постигнете с проекта или продукта. Започнете текста, като въведете раздела и споменете целите в подробен или номериран списък.
   • Ако сте представили целите в резюмето, няма нужда да правите този раздел, освен ако компанията не го изисква.
   • Напишете нещо като: „Новата система включва: 1) инструмент за планиране на маршрут; 2) функция за географско местоположение на автобуса; 3) начин пътниците да докладват за проблеми. "

3. 

   Напишете изискванията за продукта в отделна част. Въведете „Изисквания към продукта“ като заглавие и опишете какво е необходимо за разрешаване на проблема. Използвайте списък с теми и не се притеснявайте да въведете раздела.
   • Например: „1) Планировщикът на маршрута гарантира, че пътниците няма да се концентрират само върху няколко линии; 2) Контактната кутия е средство, което улеснява разрешаването на съмненията на пътниците. "

4. 

   Обяснете какво е извън обхвата на проекта. Дайте заглавието на раздела "Извън обхвата". Не пишете уводни параграфи, а просто списък с неща, които няма да бъдат направени за решаване на проблема, например каква работа няма да бъде извършена, решенията, които смятате за неподходящи и характеристиките, които продуктът или проектът не притежават. Бъдете много конкретни, за да могат потребителите и служителите да разберат съобщението правилно.
   • Напишете нещо подобно: „1) Новата система няма да промени маршрута на автобусните линии; 2) Няма да поставяме компютри или екрани на автобусните спирки, така че пътниците трябва да използват собствените си мобилни устройства; 3) Ние не гарантираме незабавно решение на проблема само чрез промяна на системата; 4) Пътниците няма да бъдат хванати на вратата. "

   Опция: обичайно е секцията да се поставя в края на техническата спецификация и преди времевата линия. Поставете го в реда, който искате, или това, което е изрично указано.

5. 

   Включете раздел „Отворени въпроси“, за да обсъдите проблеми, които тепърва ще бъдат решени. Техническата спецификация предоставя преглед на продукта или проекта, за да информира по-добре потребителите и да насочи екипа към същите цели. Не се притеснявайте да говорите за всички подробности или да решите всички проблеми, но създайте раздел, наречен „Отворени въпроси“, за да изброите точките, които ще бъдат решени по-късно.
   • Напишете например: „1) Как ще се справим със системата за актуализация? 2) Ще променим ли пътищата, ако имаме проблем? 3) Ще показва ли системата информация на други езици? 4) Как ще обслужваме пътници, които не владеят новите технологии? “

6. 

   Представете плана в раздела Приближаване. Дайте заглавието "План" или "Подход". Покажете как възнамерявате да разрешите проблемите или различните подходи, които се разглеждат, ако проектът е в началните етапи. Опишете изследванията и видовете използвани технологии и процеси. Ако е възможно, поставете изображения, графики и диаграми, за да улесните разбирането на читателите. Накрая обсъдете как ще проведете тестовете и какви стъпки ще предприемете, ако има проблеми.
   • Ако трябва да опишете различни подходи и технологии, създайте подраздел за всеки от тях.
   • Напишете нещо подобно: „Ще работим с екипа за планиране на пътуването, за да създадем приложение, което позволява на пътниците да влязат в желаната дестинация и автоматично управлява маршрута. Потребителите могат да променят маршрута. Системата изпраща текстови актуализации, за да помогне на пътниците да намерят своя маршрут. Ще включим някои клиенти в тестовата сесия, която ще се проведе преди старта. Когато има проблеми, ще правим поддръжката призори, когато автобусите не циркулират. Освен това ще имаме допълнително превозно средство за качване на пътници, които не са успели да се качат на автобус, защото е бил пълен. “

   Опция: включва раздел, озаглавен „Подготовка“, за да обобщи плана. Обикновено е по избор.

7. 

   Говорете за възможностите, които бяха разгледани, но в крайна сметка бяха изхвърлени. Поставете това съдържание като подетап от плана или в края на документа и преди времевата линия. Напишете заглавието „Разгледани алтернативи“ и ги опишете. Обяснете защо сте отхвърлили всяка опция.
   • Напишете така: „Обмислихме да използваме цветни карти с надписи, за да направим това по-евтино, но сред пътниците имаше малко признание и тестовата група беше объркана.“

8. 

   Опишете методи и измервания за оценка на продукти или проекти. Поставете съдържанието в една или повече секции. Дайте заглавието „Измерване на въздействието“, „Оценка“ или „Измервания“. Обяснете в един или два параграфа как ще осигурите правилното функциониране и постигането на целите. Също така опишете как да проверите за грешки и проблеми.
   • Говорете за процесите на анализ и технологиите, които ще бъдат използвани.
   • Кажете нещо като: „Ще направим сравнения между очакваното време на маршрутите и действителния маршрут, за да гарантираме спазването на графиците. Освен това ще проведем анкета с пътниците, за да оценим нивото им на удовлетвореност и да идентифицираме проблеми. "

9. 

   Покажете как ще запазите сигурността и поверителността. Напишете заглавието „Сигурност и поверителност“ и обяснете как ще защитите потребителите от цифрови атаки. Опишете рисковете и механизмите за защита на поверителността в няколко параграфа.
   • Винаги има рискове и проблеми, така че никога не казвайте, че те не съществуват.
   • Пишете така: „Потребителите предоставят текущото си местоположение и домашен адрес. Те могат да създадат профил и да запазят историята на пътуванията си. Ще използваме методи за криптиране и защитна стена, за да защитим данните. "

10. 

    Завършете документа с времева линия и списък с времеви марки. Графикът е важен инструмент за поддържане на проекта в реално време и показване какво точно трябва да се направи и кога. Дайте заглавието „Хронология“ и разделете задачите. Направете списък с теми за всеки екип или член.
    • Например разделението на задачите може да включва „Екип за инженеринг“, „Екип за планиране“, „Маркетинг“ и „Осигуряване на качеството“.
    • Списъкът със задачи на инженерния екип може да съдържа елементи като: „1) Разработване на актуализация за уебсайта; 2) Напишете заявление за планиране на пътуване; 3) Програмирайте система за контакти. “

Част 3 от 3: Финализиране на техническата спецификация

1. 

   Използвайте единичното интервал в документа и пропуснете ред между разделите. Единичното пространство намалява размера на техническата спецификация и улеснява манипулирането на документа. Когато променяте абзаци или раздели, просто пропуснете ред, за да избегнете добавянето на ненужни интервали.
   • Възможно е организацията да даде конкретни инструкции за форматиране. Ако е така, следвайте ги.

2. 

   Използвайте местоимението от второ лице в множествено число в документа. Докато обсъждате работата, която ще бъде извършена от вас и вашия екип, винаги използвайте „ние“. Когато споменавате конкретен екип или лице, включете пълното име, за да направите справка ясна. Така че правите техническата спецификация по-обективна.
   • Например, по-добре е да напишете „Ще актуализираме спецификациите при необходимост“, отколкото „Спецификациите ще бъдат актуализирани при необходимост“.
   • По същия начин кажете „Инженерният екип ще направи уебсайта“ или „Марта де Соуса ще отговаря за определянето на маркетинговия план“.

3. 

   Използвайте ясен, кратък и лесен за разбиране език. Не продължавайте да полирате фразите и идеите в този тип документи, защото те служат само за загуба на вашето време и на читателя. Използвайте възможно най-малко думи, за да изразите идеи по дидактичен начин. Прегледайте доклада и премахнете всички ненужни думи и повтарящи се фрази.
   • Например трансформирайте „Ще направим уебсайт, който позволява на пътниците да планират пътувания и да наблюдават автобусната пътека“ в „Сайтът ще ви позволи да планирате пътувания и да следите маршрута на автобуса“.

4. 

   Помолете колега да прегледа документа и да направи предложения или критики. Споделете техническата спецификация с членовете на екипа. Помолете ги да отбележат грешки и да предложат подобрения.
   • Не показвайте документа на някой извън полето, защото човекът може да не разбира неща, които са прости за експертите и да препоръча ненужни промени.

5. 

   Прегледайте документа, ако трябва да го промените. Вземете предложенията и критиките, когато препрочитате техническата спецификация. Най-важното е, че клиентите и членовете на екипа са лесни за разбиране. Не се притеснявайте обаче да направите нещо перфектно.
   • Вероятно ще трябва да актуализирате техническата спецификация по време на разработването на проекта или продукта. Това е временен документ, така че не се забивайте с това, което пише.

6. 

   Направете добър преглед, преди да разпространите документа. Прочетете го поне два пъти и по възможност на глас. Обърнете по-голямо внимание на печатните грешки и значението на думите.
   • Например, бъдете внимателни при промяна на „текущата система е неефективна“ на „текущата система е ефективна“.

Съвети

• Може би компанията ще ви помоли да напишете конкретни раздели. Спазвайте всички изисквания, дори ако се състои само от промяна на заглавията.