8 800 550 54 53

Прием звонков: с 09:00 до 21:00 (мск).

Без выходных.

Заказать

Прием заказов:

круглосуточно.

Техническая документация по проекту, учимся правильно оформлять

Техническая документация по проекту, учимся правильно оформлять
Техническая документация по проекту, учимся правильно оформлять
Статья создана: , обновлена:

Техническая документация

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

Если функциональность или объем выполненных работ не является очевидным для заказчика, то в интересах фрилансера составить для заказчика подробную, техническую документацию.

Документация составляется на основе технического задания и описывает особенности реализации проекта, если таковые имелись. А такие, как правило, имеются всегда.

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

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

То есть основная причина написания документации - организация эффективной работы заказчика с разработанным вами решением.

Структура документации может быть организована в следующем порядке:

  • список особых механизмов или решений, которые были введены;
  • описание причин, повлекших изменения;
  • описание схемы работы с каждым из нестандартных элементов;

Пример технической документации

При разработке дизайн можно писать следующее:

В ходе выполнения работ по проекту «Разработка дизайна для WEB сайта фирмы Вася Пупкин и Ко» было найдено эффективное решение, которое способствует повышению скорости загрузки графических элементов, а именно:

  • у предоставленных исходных данных логотипа, шапки сайта был изменен формат с gif на png;
  • в исходных данных была изменена цветовая гамма и глубина цвета;

Найденное решение не соответствует требованиям технического задания на страница №4, абзац «Исходные элементы», пункт 4.3, по следующим причинам:

  • предложенный формат считается наименее оптимальным с точки зрения механизмов сжатия графической информации [можно сразу прилагать ссылки на обзор форматов];
  • предложенная цветовая гамма общепринято считается вызывающей раздражение и негативные эмоции у пользователей [можно добавить ссылку на исследования цветовой гаммы];

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

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

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

Заказчик всегда должен иметь право на принятие окончательного решения, каким бы нерациональным оно не было. Работая дома в Интернет, примете это за правило.

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

Дополнительная информация по теме

Работая дома, портфолио - как правильно оформлять

Статья о том, как правильно оформлять собственное портфолио, работая дома, чтобы получать большие и прибыльные заказы от заказчиков

Учет времени в проектах – как выгодно использовать

Описание и инструкция, как учитывать и планировать время в больших и маленьких проектах

Класс document в VBA - учимся правильно работать

Описание, как правильно и быстро работать с классов documents, содержащий все открытые документы

Можно ли в комнатах для разговоров и IRC участвовать анонимно

Вводная статья о предназначении комнат для разговоров и сайтов IRC, механизмы обеспечения анонимности

Ссылка для обмена:

Ссылка для форума:

Ссылка для сайта:

Есть вопросы, замечания, дополнения? Пишите в комментариях.
Заказать тексты для сайта (онлайн форма) - цена от 60 рублей, срок 24 часа
работа, проект, дом, документация

Страница: Техническая документация по проекту, учимся правильно оформлять

Дата публикации: 2011-07-03 21:09. Последние изменения: 2015-07-30 14:11

наверх