Процесс разработки документации

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

Данная схема работы основана на международном стандарте Document Development Life Cycle, что позволяет нам обслуживать в том числе и самых требовательных клиентов.

Шаг 1. Инициализация проекта

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

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

Подробнее ➡️

Если в результате оценки проекта получается предсказуемое и определенное значение, то работа разбивается на этапы и формируется договор под ключ (Fixed Price), в ином случае в договоре будет почасовая оплата (Time & Material). Актуальные версии документов для ознакомления:

Договор на разработку технической документации (76КБ) ➡️ 
Счет на разработку технической документации (50КБ) ➡️ 
Акт на разработку технической документации (52КБ) ➡️ 
Соглашение о неразглашении NDA (69КБ) ➡️ 

Шаг 2. Выполнение проекта

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

Выполнение работы по постоплатной системе расчетов недоступно.

По умолчанию предусмотрены следующие этапы (в случае работы под ключ):

Этап 1. Проектирование документа

✅ выбор типа документа;
✅ выбор формата документа;
✅ разработка шаблонов;
✅ создание структуры документа;
✅ согласование с заказчиком.

Этап 2. Разработка документа

✅ сбор технической информации;
✅ разработка контента;
✅ снятие скриншотов;
✅ оформление контента;
✅ компиляция документа.

Этап 3. Выпуск документа

✅ техническая и языковая проверка;
✅ тестирование и согласование с заказчиком;
✅ устранение замечаний и финальные правки;
✅ компоновка и компиляция документа;
✅ публикация и интеграция документа.

Данные этапы могут быть пересмотрены в ряде случаев (например, в случае наличия множества документов, особо крупном проекте и т.д.).

Шаг 3. Завершение проекта

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

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

Результаты