Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Главная страница
 
Главная страница

Обсуждаем главную страницу Wiki и ее структуру
 
Коллеги, опубликовал предварительную структуру Wiki для технических писателей. Очень жду ваших добавлений и комментариев
смотреть здесь http://techwriters.ru/wiki/
 
Цитата
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. Текстовые процессоры
 
Всегда работал в authorit и думал что это программа,  вы уверены?  
 
Цитата
writer пишет:
Всегда работал в authorit и думал что это программа, вы уверены?
Не работал с AuthorIT, но в двух других уверен.   :D

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

Ну в какой-то степени это программы... это классы, методы, функции, параметры, таблицы стилей, скрипты преобразований и все такое. Смотря что понимать под программой. А еще форматы, стандарты, шаблоны, декларации, правила...
Но это далеко не редакторы.
Да в AuthorIT пользователь о технологии не думает вообще, просто выбирает стиль оформления, вставляет картинки и т.д. Тогда может и смысла нет вводить раздел Текстовые редакторы, а сделать раздел "Программное обеспечение и технологии для разработки ТД" ?, у же потом выделит отдельной главой Технологии и  ПО
 
Абсолютно забыты ГОСТы, я бы добавил это в оглавление чтобы не забыть. И виды документации расширить нужно (Пояснительная записка, ТЗ, и т.д. все что по ГОСТам нужно)
Изменено: puhata - 13.02.2014 15:40:18
 
Что-то какой-то вялый интерес к созданию Wiki для техписов... :(  неужели никому не интересно?
 
Вот предварительная структура 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]]
 
Коллеги, кто-нибудь может свежим взглядом посмотреть на  WIKI технического писателя и подредактировать то, что на ваш взгляд кажется лишним, запутанным, непонятным или просто ненужным? Можно скидывать прямо сюда в комментарии.
 




Я бы вообще убрала весь этот текст - это общая информация обо всех wiki, она не несет смысловой нагрузки для техписа, и её всегда можно найти в википедии (скорее всего оттуда текст и взят). Тут должна быть информация конкретно о wiki техписов - назначение, краткое содержание разделов, что-то, что нужно сообщить всем техписам (например, "Если есть замечания, пишите сюда"). И заголовок сделать не "Введение" (это больше подходит для учебников или книг с цельным содержанием, а не для справочных пособий, какой является wiki), а "Общая информация".
 
Что-то не понятно, прикрепился рисунок или нет... Скажите, пожалуйста, если нет )
 
2) нумерацию статей сделать вложенной, чтобы не сбиваться (см., например, п.6 - их два рядом - не оч хорошо). Оформление пунктов сделать единым (сейчас местами обычный, местами полужирный, а местами еще и курсивом, где-то с прописной, где-то со строчной, где-то без окончания, где-то на точку, где-то на точку с запятой заканчивается, лишние пробелы встречаются и т.д.)
3) пункт 5.1: "текстовые редакторы" - не ссылка, а ниже отдельно Word - почему он не отнесен к текстовым редакторам? то же про "единый источник" - почему Dita к ней не отнесена?
4) пункты 3 и 4 - непонятно: в пункте 4 перечислены доки из ЕСПД (не во всех уверена, но в большинстве), а про ЕСПД сказано в пункте 3 - почему так? доки из пункта 3 относятся к ЕСКД... вобщем, путаница какая-то... И среди них внезапно выплыл пункт "Документы, содержащие в основном сплошной текст:" - что это должно быть? ссылка на ГОСТ? в конце двоеточие, но дальше ничего не идет...
 
5) Документы из пунктов 2 и 3 повторяются
 
6) Статья "Описание элементов интерфейса" практически пуста, содержит только определение термина "элемент интерфейса", а про их описание - ничего...
 
Мне кажется, что лучше сделать вот так: не пытаться сразу составить максимальную структуру, а потом её наполнять, а наоборот написать несколько статей по теме, а потом их структурировать, дополнять и выращивать от них полноценную вики... А то сейчас вики хоть и есть, но она бесполезна, так как статьи пустые
 
Sofya, спасибо! Очень полезные правки. Рисунка нет. Вы как его добавляете?
 
Рисунок поправил. Добавляйте через "Загрузить файл"
 
А еще есть битые ссылки и ссылки, при переходе по которым сообщается, что доступ запрещен.
 
Цитата
Sofya написал:
при переходе по которым сообщается, что доступ запрещен.
оп...а где это?
 
Еще сюда продублировала скрины, а то первый раз не получилось - через ctrl + с - ctrl + v не получается вставлять
 
Битая ссылка одна - к стандартам ISO https://techwriters.ru/wiki/%D0%A1%D1%82%D0%B0%D0%BD%D0%B4%D0%B0%D1%80%D1%82%D1%­8B+ISO/
 
Еще комментарий: на скрине из вложения говорится об исходном ЯЗЫКЕ - должен быть исходный КОД, а не язык.
 
Цитата
Sofya написал:
ctrl + с - ctrl + v не получается вставлять
Sofya так нельзя вставлять) не система поддерживает!

Огромное спасибо за новые правки, буду разбираться, что там не так. vipivka-smile  
Страницы: 1
Читают тему