|
- Введение
- Что такое Wiki?
- Профессия технический писатель
- С чего начать
- Профессиональный рост
- Профессиональный стандарт
- Обучение
- Полезные ресурсы
- Словари
- Сайты
- Полезная литература
- Виды технической документации
- Конструкторская документация (ЕСКД, ГОСТ 2.102-68-2001);
- Эксплуатационная документация
- Ведомость спецификаций (ВС);
- Ведомость ссылочных документов (ВД);
- Ведомость покупных изделий (ВП);
- Ведомость разрешения применения покупных изделий (ВИ);
- Ведомость держателей подлинников (ДП);
- Ведомость технического предложения (ПТ);
- Ведомость эскизного проекта (ЭП);
- Ведомость технического проекта (ТП);
- Ведомость документов в электронной форме (ВДЭ);
- Таблицы (ТБ).
- Документы, содержащие в основном сплошной текст:
- пояснительная записка (ПЗ);
- программа и методика испытаний (ПМ);
- расчет (РР);
- инструкция (И);
- документы прочие (Д).
- Программная документация (ЕСПД, ГОСТ 19.101-77);
- Ведомость спецификаций (ВС);
- Ведомость ссылочных документов (ВД);
- Ведомость покупных изделий (ВП);
- Ведомость разрешения применения покупных изделий (ВИ);
- Ведомость держателей подлинников (ДП);
- Ведомость технического предложения (ПТ);
- Ведомость эскизного проекта (ЭП);
- Ведомость технического проекта (ТП);
- Ведомость документов в электронной форме (ВДЭ);
- Таблицы (ТБ).
- Документы, содержащие в основном сплошной текст:
- Пояснительная записка (ПЗ);
- Программа и методика испытаний (ПМ);
- Расчет (РР);
- Инструкция (И);
- Документы прочие (Д).
- Виды программной документации
- Спецификация
- Ведомость держателей подлинников
- Текст программы
- Описание программы
- Программа и методика испытаний
- Техническое задание
- Пояснительная записка
- Эксплуатационные документы
- Ведомость эксплуатационных документов
- Формуляр
- Описание применения
- Руководство системного программиста
- Руководство программиста
- Руководство оператора
- Описание языка
- Руководство по техническому обслуживанию
- Документацию на создание АС (КСАС, ГОСТ 34.201-89);
- Строительная документация (СПДС, ГОСТ 21.101-97).
- архитектурно-строительные чертежи;
- рабочая документация
- эскизная...
- Технико-эксплуатационная документация
- Разработка технической документации
- Технологии разработки документации
- Многопользовательский режим работы (Единый источник)
- Пример структуры документации
- Рекомендуемая структура руководства пользователя
- Рекомендуемая структура руководства администратора
- Общая структура раздела руководства пользователя
- Общая структура раздела руководства администратора
- Быстрый старт
- Рекомендуемая структура Быстрого старта
- Руководство по установке и удалению программного продукта
- Рекомендуемая структура справки
- Стиль написания
- Описание элементов интерфейса
- Терминология
- Правила употребления английских аббревиатур
- Правила синтаксиса, пунктуации и грамматики
- Правила выделения разделов документа
- Виды заголовков разделов документа
- Правила составления заголовков разделов документа
- Описание элементов, обязательных для всех документов
- Использование иллюстраций, таблиц и списков
- Общие требования к иллюстрациям и таблицам
- Требования к формату иллюстраций
- Предупреждение
- Примечание
- Совет
- Программное обеспечение для разработки технической документации
- Работа с текстом
- Текстовые редакторы
- Единый источник
- AuthorIT
- DocBook
- Dita
- Word
- Help&Manual
- Dr.Explain
- Программы для обработки изображений
- Snagit
- Программы для записи видеоуроков, видеоруководств
- Программы для разработки Help-справок
6.Стандарты Стандарты ГОСТ Стандарты ISO
| Зарегистрируйтесь
|
