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

• Содержание работ
• Состав комплекта документации
• Форматы представления технической документации
• Результаты работ
• Порядок разработки технической документации
• Сопровождение комплекта технической документации
• Сроки и стоимость
• Как сделать заказ

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

Содержание работы

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

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

• английский;
• русский.

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

Состав комплекта документации

Цели и задачи документирования в каждом конкретном случае зависят, во-первых, от типа документируемого технического решения, и, во-вторых, от того, как вы с этим техническим решением собираетесь обращаться. Одно дело, если вам предстоит разработать и сдать автоматизированную систему своему заказчику, и совсем другое, если вы, наоборот, заказываете и принимаете ее у исполнителя. Одно дело, если вы разрабатываете программный комплекс и продаете его 'в коробке', и совсем другое, если вы своими силами внедряете его у ваших клиентов (а если этим занимаются ваши VAR-партнеры, то третье).

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

Таблица 1. Типы технических решений и документация на них

Если вам сложно решить, какой комплект документации вам нужен, вы можете проконсультироваться с нами на этот счет.

Форматы представления технической документации

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

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

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

Таблица 2. Форматы электронной документации

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

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

Результаты работ

В результате выполнения работ вы получаете:

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

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

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

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

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

Цикл разработки комплекта технической документации включает в себя следующие основные этапы:

1. Уточнение целей и задач работы.
2. Изучение предмета документирования.
3. Формирование требований к документации.
4. Составление текста документации.
5. Согласование документации.
6. Формирование документов в нужных форматах.
7. Поставка комплекта документации заказчику.

Сопровождение комплекта документации

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

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

Сроки и стоимость

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

Разработка комплекта документации редко занимает меньше 1,5 и больше 6 месяцев. Стоимость разработки комплекта документации редко оказывается меньше 60 и больше 500 тыс. р.

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

Как сделать заказ

Позвоните или напишите нам, а еще лучше заполните форму заказа.