Как написать техническое задание (с картинками)

Оглавление:

Как написать техническое задание (с картинками)
Как написать техническое задание (с картинками)

Видео: Как написать техническое задание (с картинками)

Видео: Как написать техническое задание (с картинками)
Видео: 7 причин, почему иммигранты уезжают из Канады 2024, Марш
Anonim

Техническая спецификация (tech spec) - это документ, в котором объясняется, что будет делать продукт или проект и как вы достигнете этих целей. В технической спецификации покажите своему клиенту и членам команды, какую проблему вы решаете, цели или требования к вашему проекту или продукту и как вы планируете достичь этого. Техническая спецификация направляет работу, которую необходимо выполнить, и вы обычно переписываете ее по мере продвижения вашего проекта.

Шаги

Часть 1 из 3: написание заголовка

Напишите техническое задание, шаг 1
Напишите техническое задание, шаг 1

Шаг 1. Поместите название проекта вверху, используя шрифт без засечек размером 14 или 16 пунктов

Это название вашего продукта или рабочее название самого проекта. Используйте шрифт без засечек размером 14 или 16 пунктов, чтобы его было легко читать. Выровняйте по левому краю или по центру, в зависимости от ваших предпочтений.

Ваше рабочее место или инструктор могут предоставить вам шаблон, который покажет вам, как писать заголовок. Всегда следуйте шаблону, если он доступен

Вы знали?

Шрифт без засечек не имеет концевых штрихов на буквах, поэтому эти стили выглядят более современно. Самыми популярными шрифтами без засечек являются Arial, Calibri и Verdana.

Напишите техническую спецификацию, шаг 2
Напишите техническую спецификацию, шаг 2

Шаг 2. Напишите дату под названием проекта шрифтом без засечек размером 12 пунктов

Перейдите к следующей строке и уменьшите размер шрифта до 12 пунктов. Используйте тот же шрифт без засечек, который вы использовали для написания названия вашего проекта. Затем введите дату, используя месяц, день и год.

  • Если ваш шаблон отличается, отформатируйте дату в соответствии с шаблоном.
  • Важно указать даты, чтобы можно было сказать, какая техническая спецификация является самой последней.
Напишите техническую спецификацию Шаг 3
Напишите техническую спецификацию Шаг 3

Шаг 3. Введите «Автор» и имя автора под датой

Перейдите к следующей строке и напишите «Автор» с двоеточием. Затем укажите свое имя, так как вы пишете техническую спецификацию. Всегда указывайте только свое имя, даже если вы обсуждали содержание своей технической спецификации с командой.

У технической спецификации всегда должен быть один автор, даже если вы работаете в команде. Автор - это человек, который набирает спецификацию

Напишите техническую спецификацию Шаг 4
Напишите техническую спецификацию Шаг 4

Шаг 4. Поместите «Команда» и имена членов команды последними

В следующей строке введите «Команда» с двоеточием. Затем запишите имена каждого члена команды, который работает над проектом или продуктом.

  • Помимо признания членов вашей команды, это помогает людям понять, к кому они могут обратиться, если у них возникнут вопросы о технических характеристиках.
  • Если вы работали над этим проектом в одиночку, пропустите этот шаг.

Часть 2 из 3: Составление технической спецификации

Напишите техническую спецификацию Шаг 5
Напишите техническую спецификацию Шаг 5

Шаг 1. Предоставьте обзор или краткое изложение проекта или продукта

Начните свою техническую спецификацию с краткого описания того, что вы делаете. Введите «Обзор» или «Краткое изложение» в качестве заголовка. Объясните проблему, затем кратко опишите, что это за проект или продукт и что они будут делать. Затем объясните, каким будет ваш подход к его достижению, и включите спецификации продукта, если это оборудование. Ссылка на любую маркетинговую или техническую документацию, важную для проекта. Наконец, дайте приблизительную оценку времени, которое потребуется для завершения проекта или продукта.

Вы можете написать: «Существующая система планирования транзитных поездок через графство оставляет пассажиров в затруднительном положении и снижает количество пассажиров на определенных маршрутах. Две из автобусных систем позволяют водителям планировать поездку онлайн, а третья использует бумажные карты и телефонный контакт. Это решение снижает пассажиропоток и вызывает недофинансирование, см. Результаты опроса весны 2019 года. Мы хотим переместить все 3 линии общественного транспорта в одну систему планирования, к которой пользователи смогут получить доступ в Интернете. Это позволит им легче планировать свои поездки и видеть, когда автобусы будут на каждой остановке. Кроме того, водители могут немедленно сообщать о проблемах, используя функцию «связаться с нами» »

Напишите техническую спецификацию Шаг 6
Напишите техническую спецификацию Шаг 6

Шаг 2. Включите раздел целей, если их нет в обзоре или кратком обзоре

Введите «Цели» в качестве заголовка, а затем кратко опишите, чего вы планируете достичь с помощью своего проекта или продукта. Напишите вступительное заявление, а затем перечислите свои цели в пронумерованном или маркированном списке.

  • Если вы излагаете свои цели в обзорном разделе, этот раздел обычно вам не нужен. Однако от вас могут потребовать включить этот раздел, если этого требует ваше рабочее место.
  • Напишите что-нибудь вроде: «Новая система будет включать: 1) инструмент планирования маршрута; 2) функция локатора автобуса; 3) Способ для гонщиков сообщать о проблемах ».
Напишите техническую спецификацию Шаг 7
Напишите техническую спецификацию Шаг 7

Шаг 3. Запишите требования к продукту в отдельный раздел

Затем введите «Требования к продукту» в качестве заголовка, а затем укажите, что нужно сделать вашему продукту для решения вашей проблемы. Используйте маркированный список и не беспокойтесь о вводном предложении.

Например, «1) Планировщик маршрута следит за тем, чтобы пассажиры не застряли на мель, а автобусы не использовались недостаточно полно; 2) Поле для контактов позволяет планировщикам общественного транспорта напрямую отвечать на вопросы пассажиров »

Напишите техническую спецификацию Шаг 8
Напишите техническую спецификацию Шаг 8

Шаг 4. Объясните вещи, выходящие за рамки вашего проекта

Назовите этот раздел «Вне рамок» или «Нецелевые». Не пишите вводную часть или абзацы. Вместо этого составьте маркированный список того, что вы не собираетесь делать для решения своей проблемы. Это включает в себя работу, которую вы не будете выполнять, решения, которые, по вашему мнению, не будут работать, а также атрибуты, которых у вашего продукта или проекта не будет. Будьте внимательны, чтобы у клиента и вашей команды не возникло недопониманий.

Вы можете написать: «1) Эта система не будет добавлять новые автобусные маршруты; 2) Мы не будем устанавливать компьютеры на автобусных остановках или в автобусах, поэтому пассажирам придется использовать свои собственные устройства; 3) Планировщики транзита не гарантируют немедленное решение проблем пассажиров; и 4) Эта услуга не будет включать доставку от двери до двери »

Вариант:

Иногда этот раздел помещают ближе к концу технической спецификации перед шкалой времени. Используйте то, что вам нравится, или делайте то, что обычно на вашем рабочем месте.

Напишите техническое задание. Шаг 9
Напишите техническое задание. Шаг 9

Шаг 5. Включите раздел «Открытые вопросы», если у вас есть нерешенные проблемы

Ваша техническая спецификация - это краткое описание продукта или проекта, чтобы ваш клиент понимал, что он получает, и ваша команда работает над теми же целями. Не беспокойтесь о том, чтобы включить каждую деталь или ответить на ваши вопросы, которые будут определены позднее. Вместо этого введите заголовок «Открытые вопросы» и представьте маркированный список вещей, которые вы решите позже.

Напишите: «1) Как мы будем управлять обновлениями системы? 2) Будем ли мы менять карты маршрутов, если обнаружим проблему? 3) Может ли система обслуживать многоязычный пассажирский транспорт без ошибок перевода? 4) Как лучше всего обслуживать тех, кто не разбирается в технологиях? »

Напишите техническую спецификацию Шаг 10
Напишите техническую спецификацию Шаг 10

Шаг 6. Представьте свой план в разделе «Подход»

Назовите этот раздел «План» или «Подход». Опишите, как вы решите проблему или какие подходы вы рассматриваете, если еще не принято окончательное решение. Объясните свое исследование и каждую технологию или процесс, которые вы будете использовать. По возможности включите иллюстрации, диаграммы и диаграммы, чтобы читателям было легче понять ваш план. Наконец, обсудите, как вы будете проверять свой план и что вы будете делать в случае возникновения проблем.

  • Если вы описываете разные подходы или технологии, создайте подраздел для каждого из них, чтобы вашему плану было легко следовать.
  • Напишите что-нибудь вроде: «Мы будем работать с группой планирования общественного транспорта над разработкой программного обеспечения, которое позволит пассажирам вводить свои пункты назначения в приложение, которое будет генерировать для них маршрут. После этого всадники могут изменить маршрут, если захотят. Система будет отправлять текстовые сообщения гонщикам, чтобы помочь им найти свои маршруты. Мы собираемся пригласить участников комитета заинтересованных сторон протестировать программное обеспечение, прежде чем мы выпустим его для широкой публики. Если в плане есть ошибки, мы будем обновлять сайт в те часы, когда автобусы отключены. Кроме того, у нас будет дополнительный маршрутный автобус, чтобы подбирать пассажиров, которые оказались в затруднительном положении из-за системы ».

Вариант:

Вы можете включить раздел «Компоненты» вверху, чтобы обобщить, что повлечет за собой ваш план или подход. Однако обычно это необязательно, если этого не требует ваша компания или инструктор.

Напишите техническую спецификацию Шаг 11
Напишите техническую спецификацию Шаг 11

Шаг 7. Включите другие варианты, которые вы рассматривали, но исключили

Поместите этот раздел в качестве подэтапа в свой план или подход или поместите его в конце спецификации перед вашей временной шкалой. Введите заголовок «Другие рассмотренные варианты» и опишите альтернативы, которые вы рассматривали, прежде чем выбрать текущий план. Объясните, почему вы исключили каждый вариант.

Вы можете написать: «Мы рассматривали карты с цветовой кодировкой, потому что это более дешевый вариант, но гонщики плохо отреагировали на существующие карты, и тестовая группа запуталась»

Напишите техническое задание. Шаг 12
Напишите техническое задание. Шаг 12

Шаг 8. Опишите свои методы и показатели для оценки продукта или проекта

Включите эту информацию в один или несколько разделов. Назовите это что-то вроде «Измерение воздействия» или «Мониторинг» и «Метрики». В одном или нескольких абзацах объясните, как вы будете следить за тем, чтобы ваш продукт или проект работал правильно и соответствовал вашим целям. Кроме того, опишите, как вы будете проверять наличие ошибок или проблем.

  • Включите конкретные аналитические процессы или технологии, которые вы будете использовать.
  • Скажите что-нибудь вроде: «Мы сравним предполагаемое время в пути с фактическим временем в пути, чтобы убедиться, что автобусы идут по расписанию. Кроме того, мы проведем опрос гонщиков, чтобы оценить их удовлетворенность и выявить проблемы с системой ».
Напишите техническое задание. Шаг 13
Напишите техническое задание. Шаг 13

Шаг 9. Определите, как вы будете обеспечивать безопасность и конфиденциальность

Введите заголовок «Безопасность и конфиденциальность» и объясните, как вы защитите пользователей от кибератак. Кратко опишите риски и способы защиты вашей системы для защиты конфиденциальности. Напишите пару абзацев, чтобы объяснить свои методы.

  • Всегда есть риски или опасения, поэтому не указывайте в этом разделе «рисков нет».
  • Вы можете написать: «Пользователи будут вводить свое местоположение и свои домашние адреса. Кроме того, у них будет возможность создать профиль и сохранять поездки. Чтобы защитить эти данные, мы включим шифрование и брандмауэр ».
Напишите техническое задание. Шаг 14
Напишите техническое задание. Шаг 14

Шаг 10. Закончите с графиком и списком вех

График помогает поддерживать ваш проект в правильном направлении и сообщает как клиенту, так и вашей команде, что необходимо сделать. Назовите этот раздел «Временная шкала», а затем разбейте задачи по тем, кто их выполняет. Включите маркированный список для каждой команды или члена команды, в зависимости от ваших предпочтений.

  • Например, в разбивке по задачам может быть указано «Группа инженеров», «Группа планирования», «Маркетинг» и «Обеспечение качества».
  • Ваш список для группы инженеров может включать такие задачи, как: «1) Написать обновление веб-сайта; 2) Напишите приложение для планирования поездки; 3) Напишите контактную систему ».

Часть 3 из 3: доработка технических характеристик

Напишите техническую спецификацию Шаг 15
Напишите техническую спецификацию Шаг 15

Шаг 1. Сделайте одинарный интервал в документе и пропустите 1 строку между разделами

Используйте одинарный интервал, чтобы ваши технические характеристики были короче и с ними было легче работать. Если вы хотите изменить абзацы или разделы, просто пропустите 1 строку. Это помогает читателю идти в ногу со временем, не добавляя ненужных страниц.

Ваше рабочее место или инструктор могут дать вам другие инструкции по форматированию. Если да, следуйте этим инструкциям

Напишите техническое задание. Шаг 16
Напишите техническое задание. Шаг 16

Шаг 2. Используйте точку зрения от первого лица в своей технической спецификации

Поскольку вы обсуждаете работу, которую будете выполнять вы и ваша команда, всегда используйте местоимения от первого лица «я», «меня», «мы» и «нас». Когда вы говорите о конкретной команде или человеке, используйте их имя, чтобы было понятно, о ком вы говорите. Благодаря этому техническая спецификация будет прямой и по существу, потому что читатель знает, как будет выполняться каждое действие.

  • Например, скажите: «Мы будем обновлять спецификации по мере необходимости», а не «Спецификации будут обновляться по мере необходимости».
  • Точно так же напишите: «Команда инженеров напишет веб-сайт» или «Эми разработает маркетинговый план».
Напишите техническое задание. Шаг 17
Напишите техническое задание. Шаг 17

Шаг 3. Напишите четкий и краткий текст, которому будет легко следовать

Не уточняйте свои идеи в технических спецификациях, потому что это напрасно тратит ваше время и время вашего читателя. Используйте как можно меньше слов, чтобы выразить свои идеи и систематизировать свои мысли, чтобы за ними было легко следить. Просмотрите свой отчет и исключите ненужные формулировки и повторяющиеся предложения, чтобы ваш отчет был более прямым.

Например, вы можете изменить «Мы напишем веб-сайт, который позволит пассажирам планировать желаемую поездку и отслеживать автобус» на «Этот веб-сайт позволяет планировать поездки и отслеживать автобусы»

Напишите техническое задание. Шаг 18
Напишите техническое задание. Шаг 18

Шаг 4. Обратитесь к партнеру, чтобы он рассмотрел ваши технические характеристики и оставил отзыв

Поделитесь своими техническими характеристиками с членом команды или одноклассником, который их поймет. Попросите их отметить ошибки, которые они видят, и дать вам отзыв о том, что можно улучшить.

Не показывайте свои технические характеристики тем, кто не разбирается в вашей области. Скорее всего, они запутаются и порекомендуют изменения, в которых нет необходимости

Напишите техническую спецификацию Шаг 19
Напишите техническую спецификацию Шаг 19

Шаг 5. При необходимости внесите изменения в технические характеристики

На основе полученных отзывов вернитесь к своей технической спецификации и внесите изменения, если считаете, что они необходимы. Сосредоточьтесь на том, чтобы технические характеристики были понятны клиентам и вашей команде. Однако не беспокойтесь, что это не идеально.

Скорее всего, вам придется обновлять технические характеристики по мере развития вашего проекта или продукта. Это временный документ, поэтому не позволяйте ему мешать вам выполнять свою работу

Напишите техническое задание. Шаг 20
Напишите техническое задание. Шаг 20

Шаг 6. Вычитайте технические характеристики перед тем, как распространять их

Прочтите свою техническую спецификацию как минимум дважды, чтобы проверить наличие ошибок. Если можете, прочтите его вслух, чтобы помочь вам обнаружить свои ошибки. Сосредоточьтесь на таких вещах, как опечатки или слова, которые могут изменить смысл вашего документа.

Например, ищите такие ошибки, как «текущая система эффективна», а не «текущая система неэффективна»

Рекомендуемые: