• Главная
• Форум
• Введение в специальность
• Как составить структуру документации?

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

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

Letov001 Пользователь Сообщений: 1 Рейтинг: 5 Авторитет: 0 Регистрация: 29.06.2018	#1 Мне нравится0 29.06.2018 18:27:11 Всем привет, есть набор документов, в основном все инструкции по использованию, как для всего этого составить структуру документации? Изменено: Letov001 - 29.06.2018 18:27:33

'''''writer''''' Zakharenko Администратор Сообщений: 224 Баллов: 1184 Рейтинг: 15 Авторитет: 15 Регистрация: 08.02.2013	#2 Мне нравится0 02.07.2018 17:16:17 Друзья, кто сможет подсказать?

logunov28 Не определившийся Сообщений: 5 Баллов: 2 Рейтинг: 4 Авторитет: 0 Регистрация: 22.12.2017	#3 Мне нравится0 10.08.2018 18:35:52 Не очень понятен вопрос, если честно. Вам нужна типовая структура руководства пользователя? Или способы создать эту структуру в каком-то редакторе? Или нужна типовая структура комплекта эксплуатационной документации? Документы эти к чему относятся, к ПО или к железу? Уточните, пожалуйста, вопрос.

jararaka Не определившийся Сообщений: 3 Баллов: 1 Рейтинг: 5 Авторитет: 0 Регистрация: 14.04.2016	#4 Мне нравится0 21.08.2018 16:30:55 Вопрос не понятен. Если речь идет о комплекте документации по ОКР или проекту - это оформляется перечнем разрабатываемой документации, который может быть приложением к договору. Если перечня нет - есть ГОСТы, где расписываются комплекты документации, разрабатываемые в рамках проекта или НИР/ОКР так сказать по умолчанию. Если речь идет о документации для пользователя и ее структуре - тоже читайте ГОСТЫ серии 2.ХХХ. Там все подробно описано. Можно прямо брать оттуда структуру разделов/подразделов/пунктов/подпунктов  как "скелет", а затем нанизывать на кости "мясо". Извините за каннибальскую аналогию. Не доходит через голову - дойдет через ноги!