Оставить заявку

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

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Страницы: 1
RSS
Как составить структуру документации?
 
Всем привет, есть набор документов, в основном все инструкции по использованию, как для всего этого составить структуру документации?
Изменено: Letov001 - 29.06.2018 18:27:33
 
Друзья, кто сможет подсказать?
 
Не очень понятен вопрос, если честно.
Вам нужна типовая структура руководства пользователя? Или способы создать эту структуру в каком-то редакторе? Или нужна типовая структура комплекта эксплуатационной документации? Документы эти к чему относятся, к ПО или к железу? Уточните, пожалуйста, вопрос.
 
Вопрос не понятен. Если речь идет о комплекте документации по ОКР или проекту - это оформляется перечнем разрабатываемой документации, который может быть приложением к договору. Если перечня нет - есть ГОСТы, где расписываются комплекты документации, разрабатываемые в рамках проекта или НИР/ОКР так сказать по умолчанию. Если речь идет о документации для пользователя и ее структуре - тоже читайте ГОСТЫ серии 2.ХХХ. Там все подробно описано. Можно прямо брать оттуда структуру разделов/подразделов/пунктов/подпунктов  как "скелет", а затем нанизывать на кости "мясо". Извините за каннибальскую аналогию. hi-hi-hi
Не доходит через голову - дойдет через ноги!
Страницы: 1
Читают тему

Рейтинг@Mail.ru