Как подготовить техническое задание

Автор: | 16.08.2018

В статье рассматривает проблема написания технических заданий. Даются практические рекомендации по их составлению и оформлению.

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

Текст

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

В очень редких случаях задание бывает понято с первого раза, обычно, просчитав задание, исполнитель задает заказчику вопросы, заказчик отвечает, исполнитель снова читает и снова задает вопросы. Обычно это процесс проходит 2-3 круга, то есть, исполнитель до трех раз задает вопросы.

Значит, задание должно быть написано текстом в текстовом редакторе так, что бы исполнитель мог в любом месте раздвинуть текст и написать там свой вопрос. Если исполнитель просто раздвинет текст и напишет свой вопрос, исполнитель, при просмотре своего задания, скорее всего, без проблем обнаружит вопросы, потому-что он писал свое задание, как минимум, три дня, возможно выучил его наизусть, и может быть оно ему уже во сне снится… С исполнителем другая ситуация – он читает разные задания чуть ли не каждый день. Поэтому на очередном круге чтения задания, порой может возникнуть сомнение – а я ли задавал этот вопрос. Шутка. На самом деле не столь драматично, но проблема может быть. Поэтому должна быть возможность как-то отмечать свой текст.

Самый простой и удобный способ отметить свой текст – окрасить его другим цветом. Значит, задание должно быть написано в текстовом редакторе обеспечивающем возможность изменения цвета текста. Если у вас при написании письма по электронной почте есть возможность менять цвет текста – замечательно, все можно писать прямо в письме. Иначе придется пользоваться текстовым редактором. Самый популярный текстовый редактор, это Microsoft Word. Если не пользуется Microsoft Word, ему есть бесплатная альтернатива – Apache OpenOffice, или же еще проще – в комплект Windows входит текстовый редактор WordPad (кнопка Пуск – Стандартные – WordPad). В любом случае, если вы пользуетесь компьютером, вы должны уметь пользоваться хоть каким-нибудь боле-менее функциональным текстовым редактором.

Исполнитель отмечает свои вопросы другим цветом, затем заказчик отвечает на них, отмечая их еще каким-то другим цветом и т.д. Цвета довольно быстро кончаются. Поэтому, желательно, что бы изначально задание было написано с использование только одного цвета. Для раскрашивания текста желательно выбирать темные оттенки, избегать яркие цвета типа красного (Red), лазури (Aqua), зеленого (Lime), текст такого цвета на белом фоне очень неприятен и сложно читается.

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

Изображения

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

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

Так же, как необходимо научиться пользоваться каким-нибудь текстовым редактором, желательно научиться пользоваться хотя бы простейшим графическими редактором. В комплект Windows входит графический редактор Paint. Для создания скриншота используется клавиатура (клавиша Print Scrin или PrtScr, и т.п.), затем, в редакторе Paint на панели «Главная» надо нажать кнопку «Вставить» (крайняя слева):

Рис. 1.

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

Рис. 2.

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

Если текст не стоит окрашивать в красный цвет, то на изображениях вполне уместно делать пометки красным цветом (как на рис. 2), таким образом они лучше привлекают внимание. Не стоит на изображениях писать много текста, лучше отметить важные места линиями или стрелками и пронумеровать их (или буквами обозначить), а в тексте сделать разъяснение, например так:

1 – кнопка «Обрезать», 2 – кнопка для добавления текста на изображение, 3 – кнопка для рисования линии.

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

В терминале MetaTrader есть своя функция создания скриншотов (на графике правой кнопкой – Сохранить как изображения), но все равно, его желательно обрезать, а не вставлять как есть. Так же в терминале есть свои графические средства: лини, надписи, рекомендуется пользоваться ими, тогда в графическом редакторе останется только сделать образку изображения.

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

В крайнем случае, крупные изображения можно сохранить в папке с файлом технического задания, дать им имена: осмысленные или просто пронумеровать, а в тексте сделать упоминание этих изображений. Имейте ввиду, главное – это текст, если к нему прилагается изображение, но в тексте про него нет ни слова, оно может оказаться незамеченным. Изображения должны иметь расширение: png, gif, jpg. Избегайте изображений с расширением bmp – из файлы имеют слишком большой размер.

Как написать техническое задание

Конечно, главное в задании, это не то, как оно оформлена, а что собственно в нем написано.

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

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

Рекомендуется придерживаться некоторой конкретной терминологии. При работе в терминале MetaTrader4 допустим термин «рыночный ордер» и он по своему смыслу идентичен термину «позиция». То есть рыночный ордер и позиция это одно и тоже. Изначально в MetaTrader4 вообще не было термина «позиция», поэтому уместней пользоваться термином «рыночный ордер». А вот в MetaTrader5 есть существенная разница между рыночным ордером и позицией. Рыночный ордер – это заявка на открытие позиции и они разделены. Заявка может быть принята, но еще не исполнена, потом отклонена, а вот когда по заявке будет совершена сделка, это будет означать появление позиции. В MateTrader5 даже история торговли состоит из ордеров и сделок.

В общем, при заказе для MetaTrader4, в отношении рыночных ордеров следует говорить об их “открытии”, “закрытии”, но не об “установке” или “удалении”. Термины “установка” и “удаление” относятся к работе с отложенными ордерами. После установки отложенного ордера, он может “сработать” (стать рыночным), но не “открыться”. Термин “модификация” может относиться как к работе с рыночными ордерами так и с отложенными. При описании работы отложенными ордерами всегда следует определять тип отложенного ордера: “лимит-ордер”, “стоп-ордер” или, если необходимо подчеркнуть его направление, слово “ордер” можно не отбросить и пользоваться терминами: “бай-лимит”, “бай-стоп”, “селл-лимит”, “селл-стоп”. Отдельно термина “стоп” не должно быть в тексте, всегда должно четко определяться упоминается ли отложенный “стоп-ордер”, или защитный уровень “стоплосс”. В отношении термина “тейкпрофит” допускается его сокращения до слова “тейк” (но не желательно), использование термина “профит” для обозначения “тейкпрофита” недопустимо. В отношении термина “профит” или “прибыль” желательно указывать, какая прибыль подразумевается – в пунктах или в валюте.

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

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

О чем писать в техническом задании

Теперь самое интересное – о чем писать в техническом задании и вообще как к нему подступиться.

Практическое использование эксперта начинается с присоединения его на график. Очевидно, что при этом в рынке нет позиции открытой этим экспертом. Это и является исходной точкой, с которой нужно начинать писать задание.

Значит, первое, о чем нужно написать, это условия открытия позиции, или условия установки ордера или группы ордеров, если эксперт работает отложенными ордерами. Это может быть показание какого-то индикатора, например RSI пересек уровень 30 внизу вверх. Это может быть сочетание показаний каких-то индикаторов, например быстрая скользящая средняя пересекала медленную снизу вверх, при  этом индикатора RSI находится выше уровня 50. Это может быть заданное время… и пр.

Закрытие позиций может выполняться по стоплсс/тейкпрфит или по рынку. Поэтому, если используется столпосс/тейкпрофит, нужно написать по каким правилам они определяются: фиксированный в пунктах или на основе какого-то индикатора, расчетов и т.п.

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

Условия закрытия по рынку подобны условиям открытия.

После открытия позиции она может сопровождаться различными функциями, например трелйингом или безубытком, которые могут работать как угодно по-разному (о чем и надо написать).

Если эксперт начинает работу отложенными ордерами, у них так же могут быть функции сопровождения типа трейлинга, например ордер подтягивается за ценой по мере ее изменения. При использовании отложенных ордеров обязательно надо подумать о правилах их удаления. Например, эксперт начинает работу с установки двух ордеров: бай-стоп и селл-стоп, если один из них сработал, второй надо удалить. Вообще, использование отложенных ордеров может быть достаточно сложным (в смысле, алгоритм их использования). Например, при срабатывании отложенного ордера на его стоплосс может ставиться противоположный стопордер, а на тейкпрофит – противоположный лимитный и т.п.

Основные моменты:

  • Правила начала работы (открытие позиций, установка отложенных ордеров).
  • Правила расчета стоплосса/тейкпрфита, лота.
  • Правила закрытия позиций и удаления отложенных ордеров.
  • Функции сопровождения.

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

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

Работа над ошибками

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

Если эксперт работает в реальном времени на счете, в первую очередь посмотрите логи терминала (каталог logs) и эксперта (каталог experts\logs), имена фалов соответствуют дате за которую сохранялись логи. Возможно был обрыв связи, не было цен (ошибка 136), или брокер был занят (ошибка 137) и т.п., наиболее распространенные ошибки из-за которых эксперт не работает вообще: 130 (неправильные стопы) и 131 (неправильный объем ордера). Ошибка 130 возникает из-за попытки установить стоплосс, тейкпрофит или отложенный ордер слишком близко к рыночной цене, или запрещено открытие рыночного ордера с заранее определенными стоплосс и тейкпрофит, в этом случае, следеут более подробно ознакомьтесь с торговыми условиями дилингового центра в котором у вас открыт счет и проверить соответствие параметров советника этим торговым условиям. Затем следует провести тестирование советника в тестере с теми же параметрами, с которыми он работал на счете.

Если эксперт работает неправильно в тестере:

  1. Сохраните отчет после тестирования (правой кнопкой мыши во вкладке “Результаты” тестера – “Сохранить как отчет”).
  2. Сохраните файл настроек с которыми тестировался эксперт (кнопка “Свойства эксперта” в тестере, при этом откроется окно свойств эксперта, в котором есть кнопка “Сохранить” (внизу окна), при помощи этой кнопки и сохраняются все параметры эксперта в файл).
  3. Скриншоты со стрелками ордеров после тестирования. Обязательно убедитесь, что параметры индикаторов на графике после тестирования соответствуют параметрам эксперта, если это не так, удалите шаблон “tester” (правой кнопкой мыши на графике – “Шаблон” – “Удалить шаблон”) и заново проведите тестирование. На скриншотах пометьте места неправильной работы при помощи графических объектов, создайте одну две надписи с номерами тикетов ордеров, чтобы можно было найти соответствие скриншоту и отчету.

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