Консультации по вопросам документирования

• Предмет консультаций
• Типичные темы консультаций
• Рецензирование документации
• Платные консультации
• Бесплатные консультации
• Задать вопрос и получить консультацию

Предмет консультаций

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

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

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

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

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

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

Типичные темы консультаций

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

Таблица 1. Типичные темы консультаций

Тема	Круг вопросов
Отношения исполнителя и заказчика	Какую документацию требовать от исполнителя? Какую документацию предоставлять заказчику? Как составить требования к документации? Как организовать сдачу-приемку документации?
Организация документирования	Кто должен отвечать за документирование? Кто должен участвовать в документировании? Как получить информацию у носителей знания? Каким должен быть корпоративный стандарт?
Стандарты	Какие стандарты нужны в конкретной ситуации? Где и как получить тексты нужных стандартов? Как понимать и применять эти стандарты? Как проверить, что стандарты соблюдены?
Состав и содержание документации	Какие сведения включать в документацию? Как распределить их по документам? Как озаглавить и обозначить документы? Какими должны быть структуры документов?
Терминология	Каким термином обозначить то или иное явление? Из каких источников заимствовать терминологию? Как составить глоссарий по определенной теме? Как внедрить в компании единую терминологию?
Требования к документам	В каком порядке излагать материал в документе? Каким должен быть стиль изложения материала? Какими должны быть оглавления, указатели и др.? Как внешне должен быть оформлен документ?
Электронная документация и ее форматы	В каких форматах отдавать документы аудитории? Как снабдить приложение справочной системой? Как правильно публиковать документацию в сети? Как создать электронный архив документации?
Средства разработки. Автоматизация	В каком формате разрабатывать документацию? Как сформировать документы в нужных форматах? Какие программные средства для этого выбрать? Как их приобрести, установить и настроить?

Рецензирование документации

Рецензирование документации полезно в следующих случаях:

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

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

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

По результатам рецензирования мы предоставляем вам отчет с выводами и рекомендациями.

Платные консультации

Цель консультации, как правило, состоит в том, чтобы выработать подход к решению той или иной практической задачи, которую жизнь ставит перед заказчиком. Эта задача может быть как масштабной (например, организация регулярного документирования в ИТ-департаменте), так и частной или даже чисто технической (например, конвертация большого объема документации из одного формата в другой).

В простейшем случае консультация может быть проведена в форме совещания (или нескольких совещаний) с участием сотрудников 'Философта' и лиц, вовлеченных в решение проблемы.

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

1. Вы отправляете нам запрос через форму или любым другим удобным вам способом.
2. Мы с вами обсуждаем задачу, уточняем ее и подписываем договор.
3. В течение оговоренного срока мы проводим необходимые исследования.
4. Мы предоставляем вам результаты в оговоренной форме.
5. Мы с вами обсуждаем результаты и делаем выводы.

Результаты консультационной работы могут быть представлены в следующих формах:

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

Задать вопрос и получить консультацию.

Бесплатные консультации

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

• Вы можете воспользоваться бесплатной консультацией только один раз.
• В рамках бесплатной консультации мы отвечаем вам на один вопрос.
• Ваш вопрос должен касаться только разработки технической документации.
• Ваш вопрос должен прямо относиться к вашим практическим задачам.
• Ваш вопрос должен быть сформулирован конкретно и лаконично.
• Ваш вопрос не должен представлять собой просьбу сделать что-либо за вас.
• Мы постараемся дать вам полезный ответ в течение пяти рабочих дней.

Задать вопрос и получить консультацию.