Составление технологической документации

1. Тема: Составление технологической документации

Работу выполнил: Филиппов Владислав

2. Определение

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

3. Корпоративный стандарт

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

4. Основные функции корпоративного стандарта

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

5. Откуда берётся корпоративный стандарт

Как правило, он является результатом
накопленного опыта по составлению
документации, и кроме того базируется на
стандартах компании Microsoft и ГОСТ.
Хороший корпоративный стандарт так же
учитывает лучшие образцы документации к
западным и отечественным программным
продуктам.

6. Кто составляет корпоративный стандарт

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