Wiki для разработчиков технической документации

Предварительная структура Wiki

wiki → Предварительная структура Wiki  
Чтобы стать редактором Wiki оставьте заявку в произвольной форме на форуме 


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


6.Стандарты
Стандарты ГОСТ

Стандарты ISO
Это нравится:0Да/0Нет

Зарегистрируйтесь