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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Какой стандартный пакет документации Вы разрабатываете на новое ПО, Стандартный пакет документов на ПО (программное обеспечение)
 
Есть у нас тема о стандартном наборе ГОСТов для разработки документации на ПО.
Хочу задать вопрос о том, какой пакет документов Вы разрабатываете на новую программу исходя из корпоративных стандартов вашей компании? Интересно собрать какую-то общую вытяжку, которая, наверняка, пригодится для всех технических писателей и поможет аргументировать существование того или иного документа, или наоборот отказаться от него.  
Не скрывайте, делитесь)
 
У нас набор документов, который мы должны подготовить, прописывается в договоре. Минимум - это ТЗ, РП, РА, и ПиМИ.  Иногда некоторые документы "распадаются", например, РА - на "Руководство функционального администратора", "Руководство по инсталляции и настройке" и т.д. Бывали случаи, когда с нас просили много чего, вплоть до ведомости и формуляра (это все на АСУ).
 
У нас тоже прописывается в договоре. Или в ТЗ. Обычно примерно такой такой набор:
На предпроектной стадии - ТЗ.
На стадии проектирования - Описание программного обеспечения, Описание информационного обеспечения.
При вводе в эксплуатацию - Программа и методика испытаний, Руководство администратора, Руководство пользователя.
 
Ирина и Марина спасибо! Еще у кого какие мысли по этому поводу?  
 
Разрабатываемый комплект документов во многом зависит от специфики проекта. В некоторых проектах, как указали некоторые участники обсуждения, комплектность разрабатываемых указывается в контракте (договоре). Если требований к комплектности нет, то для начала необходимо спроектировать комплект.
Я бы разбивала комплект, в первую очередь, по уровню владения программой пользователем. Для начинающего пользователя логично разработать словарь терминов (глоссарий), туториалы, быстрый старт, руководство пользователя по выполнению основных типовых действий. Для опытного пользователя можно разработать подробное руководство пользователя, справочники и пр. Для продвинутых пользователей (администраторов, разработчиков) - руководство администратора (разработчика).
Стоит подумать над форматом каждого вида документа: разделить, какие документы будут в печатном виде, какие в электронном и т.д.
techwriter.ru.com
 
techwriter, спасибо! Подводя итог.... получается вот такой минимальный комплект документации (если разработка документации не регламентируется ГОСТами и контрактом):

  1. ТЗ (если системы еще нет)
  2. Руководство пользователя
  3. Руководство администратора
  4. Быстрый старт
  5. Глоссарий (словарь терминов, может быть включен в оба руководства)
  6. Типовые сценарии работы с системой
  7. Техническое описание системы
  8. Help (on-line справка)
Как думаете, такого комплекта для начала хватит? Есть что добавить?
Страницы: 1
Читают тему