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

Главная страница

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



Wiki для технических писателей


  1. Введение
  2. Что такое Wiki?
  3. Как стать редактором Wiki для технических писателей?
  4. Профессия технический писатель

    1. Кто такой технический писатель?
    2. С чего следует начинать техническому писателю?
    3. Уровни квалификации технического писателя
    4. Профессиональный стандарт технического писателя
    5. Обучение
    6. Полезные ресурсы
      1. Словари
      2. Сайты
      3. Статьи
    7. Библиотека технического писателя

  5. Виды технической документации

    1. Конструкторская документация (ЕСКД, ГОСТ 2.102-68-2001);
    2.  Эксплуатационная документация

      1. Ведомость спецификаций (ВС);
      2. Ведомость ссылочных документов (ВД);
      3. Ведомость покупных изделий (ВП);
      4. Ведомость разрешения применения покупных изделий (ВИ);
      5. Ведомость держателей подлинников (ДП);
      6. Ведомость технического предложения (ПТ);
      7. Ведомость эскизного проекта (ЭП);
      8. Ведомость технического проекта (по ГОСТ 2.106) (ТП);
      9. Ведомость документов в электронной форме (ВДЭ);
      10. Таблицы (ТБ).
      11. Документы, содержащие в основном сплошной текст:
      12. Пояснительная записка (ПЗ);
      13. Программа и методика испытаний (ПМ);
      14. Расчет (РР);
      15. Инструкция (И);
      16. Документы прочие (Д).
      17. Отчет о нагрузочном тестировании

    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.  Описание языка
      17. Руководство по техническому обслуживанию



    5. Документацию на создание АС (КСАС, ГОСТ 34.201-89);
    6. Строительная документация (СПДС, ГОСТ 21.101-97). 

      1. архитектурно-строительные чертежи;
      2. рабочая документация
      3. эскизная...

    7. Технико-эксплуатационная документация

  6. Разработка технической документации

    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. Примечание
      15. Совет 

    5. Программное обеспечение и технологии для разработки технической документации

      1. Работа с текстом

        1. Текстовые редакторы
        2. Единый источник
        3.  AuthorIT
        4. DocBook
        5. Технология Dita
        6. Microsoft Word
        7. Help&Manual
        8. Dr.Explain

      2. Программы для обработки изображений
        1. Snagit

      3.  Программы для записи видеоуроков, видеоруководств
      4. Программы для разработки Help-справок

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

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

Обсуждение структуры  здесь


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

Это нравится:0Да/0Нет
writer
Коллеги, опубликовал предварительную структуру Wiki для технических писателей. Очень жду ваших добавлений и комментариев
смотреть здесь http://techwriters.ru/wiki/
Это нравится:2Да/0Нет
'ADVANCED'
Цитата
writer пишет:
Коллеги, опубликовал предварительную структуру Wiki для технических писателей. Очень жду ваших добавлений и комментариев
смотреть здесь http://techwriters.ru/wiki/
Цитата
5. Программное обеспечение для разработки технической документации
  • Текстовые редакторы
    • Единый источник
      • AuthorIT
      • DocBook
      • Dita
    • Word
    • Help&Manual
    • Dr.Explain
  • Программы для обработки изображений
    • Snagit
  • Скринкастинг
  • Программы для разработки Help-справок
1. AuthorIt, Dita и Docbook - это не редакторы. Это технологии.
2. Word - это не текстовый редактор и редактирует он бинарные файлы, а не текстовые.

5. Программное обеспечение для разработки технической документации
5.1 Единый источник
- AuthorIT
- Dita - Docbook
5.2. Текстовые редакторы
5.3. Текстовые процессоры
Это нравится:0Да/0Нет
writer
Всегда работал в authorit и думал что это программа, вы уверены?
Это нравится:1Да/0Нет
'ADVANCED'
Цитата
writer пишет:
Всегда работал в authorit и думал что это программа, вы уверены?
Не работал с AuthorIT, но в двух других уверен. :D

Ну в какой-то степени это программы... это классы, методы, функции, параметры, таблицы стилей, скрипты преобразований и все такое. Смотря что понимать под программой. А еще форматы, стандарты, шаблоны, декларации, правила...
Но это далеко не редакторы.
Это нравится:0Да/0Нет
writer
Цитата
'ADVANCED' пишет:
Цитата
writer пишет:
Всегда работал в authorit и думал что это программа, вы уверены?
Не работал с AuthorIT, но в двух других уверен. :D

Ну в какой-то степени это программы... это классы, методы, функции, параметры, таблицы стилей, скрипты преобразований и все такое. Смотря что понимать под программой. А еще форматы, стандарты, шаблоны, декларации, правила...
Но это далеко не редакторы.
Да в AuthorIT пользователь о технологии не думает вообще, просто выбирает стиль оформления, вставляет картинки и т.д. Тогда может и смысла нет вводить раздел Текстовые редакторы, а сделать раздел "Программное обеспечение и технологии для разработки ТД" ?, у же потом выделит отдельной главой Технологии и ПО
Это нравится:0Да/0Нет
puhata
Абсолютно забыты ГОСТы, я бы добавил это в оглавление чтобы не забыть. И виды документации расширить нужно (Пояснительная записка, ТЗ, и т.д. все что по ГОСТам нужно)
Это нравится:0Да/0Нет
''writer''
Что-то какой-то вялый интерес к созданию Wiki для техписов... :( неужели никому не интересно?
Это нравится:0Да/0Нет
writer
Вот предварительная структура WIKI? которая была на первоначальном этапе. Может начнем с нее? Выложим на главную страницу и там уже будем править?


1. Введение
1. Что такое Wiki?
2. Профессия технический писатель
1. С чего начать
2. Профессиональный рост
3. Профессиональный стандарт
4. Обучение
5. Сайты для технических писателей
6. Полезная литература
3. Виды технической документации
1. Конструкторская документация (ЕСКД, ГОСТ 2.102-68-2001);
· Конструкторская документация
· Эксплуатационная документация
1. ведомость спецификаций (ВС);
2. ведомость ссылочных документов (ВД);
3. ведомость покупных изделий (ВП);
4. ведомость разрешения применения покупных изделий (ВИ);
5. ведомость держателей подлинников (ДП);
6. ведомость технического предложения (ПТ);
7. ведомость эскизного проекта (ЭП);
8. ведомость технического проекта (ТП);
9. ведомость документов в электронной форме (ВДЭ);
10. таблицы (ТБ).
Документы, содержащие в основном сплошной текст:
11. пояснительная записка (ПЗ);
12. программа и методика испытаний (ПМ);
13. расчет (РР);
14. инструкция (И);
15. документы прочие (Д).
· Ремонтная документация
2. Программная документация (ЕСПД, ГОСТ 19.101-77);
· Виды программной документации
1. Спецификация
2. Ведомость держателей подлинников
3. Текст программы
4. Описание программы
5. Программа и методика испытаний
6. Техническое задание
7. Пояснительная записка
· Эксплуатационные документы
1. Ведомость эксплуатационных документов
2. [[Формуляр|Формуляр]]
3. Описание применения
4. Руководство системного программиста
5. Руководство программиста
6. Руководство оператора
7. Описание языка
8. Руководство по техническому обслуживанию

3. Документацию на создание АС (КСАС, ГОСТ 34.201-89);
4. Строительная документация (СПДС, ГОСТ 21.101-97).
1. архитектурно-строительные чертежи;
2. рабочая документация
3. эскизная...
10. Технико-эксплуатационная документация
2. Разработка технической документации

1. Технологии разработки документации
2. Многопользовательский режим работы (Единый источник)
3. Категории пользователей
4. Комплекты документации
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. Текстовые редакторы
2. Единый источник
0. AuthorIT
1. DocBook
2. Dita
3. Word
4. Help&Manual
5. Dr.Explain
6. Программы для обработки изображений
1. Snagit

7. Скринкастинг
8. Программы для разработки Help-справок


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

[[Стандарты ISO|Стандарты ISO]]
Зарегистрируйтесь