Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
На какие вопросы должен ответить раздел (топик), описывающий работу определенного модуля в системе, разрабатываем техническую документацию
 
Давайте упростим работу другим техническим писателям и опишем то,  на какие вопросы должен ответить определенный раздел (топик) описывающий работу какого-то модуля/функционала в системе.

Итак, примерный список вопросов, дополняем и расширяем:

  1. Зачем нужен?
  2. Какие функции выполняет?
  3. Где применяется в системе ?
  4. Как настроить?
  5. Пример работы.
 
Для кого предназначен?
techwriter.ru.com
 
Например, данный топик должен ответить на вопросы по сертификации программного обеспечения, если считать, что модуль системы можно рассматривать как самостоятельно функционирующее средство, так  и зависимое, например от операционной среды... вообщем, в некоторых случаях можно поставить знак равенства между модулем и компонентом. Только слово компонент более содержательное.
Как-то попал в руки один шаблон документа я счёл полезным для себя... ниже привожу ссылку для скачивания.

Вопросы по сертификации ПО - скачать
Страницы: 1
Читают тему