Составляем ТЗ на английском
О важности правильно составленного и правильно понятого технического задания в работе любой IT-команды говорить не стоит. Вопрос в том, как правильно написать его на английском. А если вы работаете в международной команде, это потребуется обязательно. Без паники! EnglishDom расскажет, как написать ТЗ на английском и не наделать ошибок. Итак, обо всех важных моментах - по порядку.
SRS structure. Структура ТЗ
В техзадании обязательно присутствуют следующие разделы:
- introduction - вступление,
- overall description - общее описание,
- specific requirements - специфические требования, а также возможны и appendices - приложения.
Поговорим о каждом разделе отдельно.
- В introduction, помимо purpose - цели, может быть включен еще и scope - объем работ, definitions - термины, специфичные и принятые для этого ТЗ, и раздел overview, который дает общее представление о наполнении и структуре будущего проекта - identify the product, describe the content and the structure.
- Overall description - это раздел, который включает многое:
- product perspective - функционал будущего продукта, который описывает все внешние интерфейсы - describes all external interfaces,
- functions - главные функции продукта (summary of major functions),
- constraints, or anything that limits our options - возможные ограничения,
- use cases - сценарии использования.
- specific requirements - все, что можно назвать требованиями, идет в этот раздел. Собственно, это и есть его основной частью - body of the document.
Итак, структура ТЗ в общем виде должна выглядеть так:
- Introduction: purpose / scope / definitions
- Overall description: product perspective / functions / constraints / use cases
- Specific requirements: all the possible requirements = body of the document
- Useful phrases: identify / limit options, content, structure, product, external interfaces
Overview is a section that identifies the product and describes the content and the structure. - Общее представление - это раздел, который определяет проект и описывает наполнение и структуру.
Anything that limits our options is described in the constraints. - Все, что как-либо лимитирует варианты действий, указано в разделе “ограничения”.
All the possible requirements usually identify the body of the document. - Все возможные требования определяют главную часть документа.
Характеристики ТЗ
Есть несколько ключевых характеристик ТЗ.
- Первое - оно должно быть correct - правильным, то есть up to the required standards for the quality, database integrity and so on - соответствовать требуемым стандартам по качеству, целостности базы данных и т.д.
- Второе - unambiguous and complete - недвусмысленным и полным, чтобы четко описать проект и его функционал - describe what is the future project created for.
- Третье - consistent and detailed - последовательным и детальным, подробно описывающее, каким будет взаимодействие с людьми, оборудованием и другими внешними интерфейсами - how it interacts with people, hardware and other external interfaces.
- Четвертое - modifiable and traceable - поддающееся изменениям и их отслеживанию, то есть the one you can edit and control.
Видео курсы по схожей тематике:
Ряд фраз, которые вам пригодятся:
imposed on an implementation - обязательный к внедрению,
main considerations - ключевые факторы,
operation environment - рабочая среда.
Итак, ТЗ должно быть:
- Correct: up to the required standards for the quality / database integrity
- Unambiguous and complete: describe what is the future project created for
- Consistent and detailed: how it interacts with people, hardware and other external interfaces
- Modifiable and traceable: the one you can edit and control
Полезные фразы: imposed on an implementation / main considerations / operation environment.
SRS typical mistakes. Как не испортить ТЗ
Столько деталей и нюансов, подпунктов, что сложно не ошибиться. Мы расскажем, чего стоит избегать.
- Первое: ambiguity - неясность. don’t give too much or too little information that may not be verified - не стоит давать чересчур много или мало информации, которую, к тому же, еще и проверить нельзя.
- Второе: requirements on users - требования к пользователям. Запомните, you can only assume what user will do - нельзя заставить пользователя, можно только предположить, что он будет делать.
- Третье: unnecessary or invented terms - термины, которые не нужны или выдуманы. Avoid any extra terms if you can say it simple - избегайте лишней терминологии, если все можно сказать проще.
Бесполезные и ненужные в ТЗ вещи: forward reference - ссылка наперед, contradiction - противоречие, noise - лишняя информация, silence - недостаточное описание.
Бесплатные вебинары по схожей тематике:
В общем, придерживайтесь структуры, избегайте лишней информации, используйте ключевые фразы - и ваше ТЗ будет идеальным!
Если же вы сомневаетесь в своем знании английского - в EnglishDom есть специальный курс “Английский для IT”, где вы сможете подтянуть все важные для it-шника темы. Научитесь писать резюме и CV, проходимть собеседования, обсуждать проекты и проводить переговоры, переписываться в чате, писать ТЗ и деловые письма, понимать носителей языка и читать зарубежные блоги.
Статьи по схожей тематике
