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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1 2 3 4 5 След.
RSS
Технический писатель, направления для развития, Обсуждаем какие профессиональные направления развития есть у технического писателя
 
Тут задался вопросом, в каких направлениях развиваться? Вижу, от тех. писателя требуется либо знание ГОСТ, либо технический английский, редко сразу оба. Часто поощряется Linux, DocBook, LaTeX, DITA. Как вы видите для себя развитие в области?
 
Linux, Docbook, LaTEX, DITA   :)  
Лень никак не пересилит необходимость английского.   :(
Изменено: ADVANCED - 06.10.2014 11:45:10
 
Не, начальное знание английского нужно везде, это да. Я имею в виду случаи, когда требуется читать либо писать документацию на английском (в этих случаях обычно пишут "не ниже Intermediate"). То есть не пару слов перевести, а работать с большими объемами текста на английском.
 
Windows+Word+ГОСТ = тупиковая ветвь развития  wall-smile .

Linux+XML = whole world +  beach-smile
 
А как стандарт ISO? вижу, он мало где требуется? потому что дорого? =)
 
Я не сталкивался с ними никак, кроме этого.
 
Цитата
fs444 пишет:
А как стандарт ISO? вижу, он мало где требуется? потому что дорого? =)
Стандартов ISO много тысяч, из них к созданию технической документации относятся несколько десятков.

Это не дорого. Просто не по сеньке шапка. Эти стандарты ориентированы на уровень технологий и уровень организации и менеджмента разработок, который в российских коммерческих организациях будет достигнут лет через 20, а в государственных и обслуживающих их организациях - дай Бог лет через 50. Пока же нам милее и понятнее ГОСТЫ 1970 гг.
 
Цитата
Пока же нам милее и понятнее ГОСТЫ 1970 гг.
То есть ГОСТЫ лучше сразу в помойку? просто про них много написано, как применять и тп.
 
в топку ГОСТ.
Еще смотрите в сторону многопользовательской работы с документацией, в сторону мультимедии
 
Цитата
fs444 пишет:
Тут задался вопросом, в каких направлениях развиваться? Вижу, от тех. писателя требуется либо знание ГОСТ, либо технический английский, редко сразу оба. Часто поощряется Linux, DocBook, LaTeX, DITA. Как вы видите для себя развитие в области?
Зависит от задач, которые ставятся при приёме на работу. Да и востребованность технического писателя зависит от того, насколько он умеет адаптировать имеющуюся документацию под нужды конторы. К технологиям и инструментариям это мало имеет отношения, как правило. Пользователю без разницы, каким образом вы достигаете того, что ему документация доступна, понятна, полезна и удобна.
Я бы в первую очередь, любому начинающему техническому писателю посоветовала бы поупражняться именно в качественном составлении самого контента. Все остальное вторично.
techwriter.ru.com
 
И, конечно, нужно развивать основной навык технического писателя - отличное знание русского языка. Все довольно печально в этом плане. Очень сложно найти просто грамотного технического писателя. Технического писателя, который умеет грамотно излагать текст, можно обучить пользоваться любым инструментарием. Вот, с неграмотным техническим писателем все очень тухло.
techwriter.ru.com
 
имхо любой инструмент хорошо осваивается в процессе работы над реальными задачами, для которых он подходит. Или, возможно, с наставником, который предлагает подходящие под инструмент задачи и оценивает результат. Изучать что-то в теории для строчки в резюме, по-моему, не очень осмысленно.

Для себя вижу развитие в изучении смежных областей - бизнес-анализ, анализ и проектирование интерфейсов, работа с требованиями. Ну и русский язык можно развивать до бесконечности - читать хорошую художественную литературу, переписывать свои или чужие тексты, делая их более понятными, обращаться к справочникам, если возникают сомнения, "как правильно это написать".
 
Наверное, ГОСТ можно использовать в качестве образца "как можно написать" (например, для написания руководств пользователя, администратора, программиста). Но в некоторых учреждениях это доведено до маразма, чтобы каждое поле для подписи и каждый заголовок был обозначен =)
 
Цитата
fs444 пишет:
Наверное, ГОСТ можно использовать в качестве образца "как можно написать" (например, для написания руководств пользователя, администратора, программиста).
В качестве образца его нельзя использовать. ГОСТ придумали для однообразия "ведения учета по децимальным номерам" и "складирования" документации в подземных хранилищах с черт знает каких времен. Последние обновления были в 70-х годах. В 90-х что-то поправили, но суть не изменилась.
Ни одно руководство, выполненное по ГОСТ, не будет удобным для пользователя, даже скорей будет бесполезным и вредным для лесного массива страны.  
 
Цитата
Ни одно руководство, выполненное по ГОСТ, не будет удобным для пользователя
То есть все вакансии, где требуется знание ГОСТ, лучше сразу выкидывать как застойные?  :D
 
34 гост введен в действие в 90-х годах. Техническое задание отлично пишется по 34 госту, если использовать его в ситуации, для которой он и был предназначен - создание автоматизированной системы "под ключ", включая установку и настройку ПО на технике заказчика, возможно, поставку или апгрейд техники, обучение персонала.

Посмотрела сейчас на требования ГОСТ к руководству пользователя - не понятно, что там может быть бесполезным. По-моему, перечислен необходимый минимум того, что должно быть в документе. Гост не запрещает что-то добавлять или менять. Он вообще ничего не запрещает, а только предлагает  шаблоны, которые часто оказываются полезными и удобными.  
 
Цитата
Марина пишет:
34 гост введен в действие в 90-х годах. Техническое задание отлично пишется по 34 госту, если использовать его в ситуации, для которой он и был предназначен - создание автоматизированной системы "под ключ", включая установку и настройку ПО на технике заказчика, возможно, поставку или апгрейд техники, обучение персонала.
34 ГОСТ про техническое задание (ГОСТ 34.602-89) введен в 1989 году, идеология там от 1970-х гг. По сравнению со стандартом IEEE/ISO/IEC 29148-2011 "Systems and software engineering -- Life cycle processes -- Requirements engineering" это каменный век. На поставку и апгрейд информационных систем и обучение персонала имеются отдельные и тоже весьма подробные стандарты. Зато в ГОСТ 34 больше половины содержимого - про формочки и рамочки.

Если начальство и руководство заказчика находится по своему развитию на уровне 70-80 гг. прошлого века. то ГОСТ 34.602-89 это именно то что надо.
 
ГОСТ предполагает документацию в печатном виде (печатным способом) или файлы "на магнитном носителе". Хоть комиксы добавьте, хоть раскраски это не станет полезным пользователю. Ему пофиг на однообразные заголовки и рамки. Нужна доступная справка.

Процитировать сообшения не могу щас (с телефона.,Если отвечать на вопрос по ГОСТ И вакансии с ними - да, в топку. Для таких вакансий найдется свой персонал с консервативными взглядами и исполнительностью.

Если интересно развиваться, я бы порекомендовал смотреть в сторону веб-справки, онлайн хелп, вики-системы. Сейчас разрабатывается все больше систем с веб-интерфейсом, а самое важное - под мобильные платформы. Это 21 век и переспектив множество. Никакую печатную литературу никто скоро читать не будет. Методички и учебные пособия на курсах будут, но там смесь тех.док и маркетинга и делают такие доки не писатели.

Представьте  чела с шестым айфон в одной руке и  200-страничным толмутом инструкции (черно-белой с рамочками) в другой руке.   )))))))

Украинские коллеги, работающие в ворде этой зимой будут востребованы. Газа мало, топить можно распечатанной документацией. Прям по номенклатуре брать, чтобы не путаться.  
 
Интересно, как по-разному можно толковать словосочетание "документация по 34 госту". В текстах 34 госта рамочки, по-моему, вообще не упоминаются. Есть ссылки на ЕСКД, ЕСПД и т.д., рамочки, наверно, оттуда. Я их видела на схемах и чертежах, которые готовили другие отделы или субподрядчики. С требованием сделать рамочки на текстовых документах ни разу за 3 года не сталкивалась. Настроить стили заголовков в ворде - минутное дело, это вообще глупо обсуждать.

У нас обычно под работой по 34 госту подразумевается разбиение проекта на этапы
1) техническое задание
2) технический проект
3) рабочая документация (2 и 3 часто объединяют)
4) ввод в действие

По каждому этапу должно быть написано один-два документа из списка http://standards.narod.ru/gosts/gost34/34-201-89.htm, их разделы и содержание должны быть как-то похожи на то, что написано в госте (обычно никто не сверяет, но если решат, что в документе не хватает чего-то важного, сошлются на гост). Для конечного пользователя из этих документов предназначено полтора, и никакой гост не запрещает кроме них сделать ещё и онлайн-хелп. Все эти документы читают не обязательно айтишники и "челы с шестыми айфонами". Инженеры старой закалки не меньше челов с айфонами заслуживают документации, подготовленной в удобном и привычном для них виде.
 
Цитата
Марина пишет:
Интересно, как по-разному можно толковать словосочетание "документация по 34 госту". В текстах 34 госта рамочки, по-моему, вообще не упоминаются. Есть ссылки на ЕСКД, ЕСПД и т.д., рамочки, наверно, оттуда. Я их видела на схемах и чертежах, которые готовили другие отделы или субподрядчики. С требованием сделать рамочки на текстовых документах ни разу за 3 года не сталкивалась.
В этом году по одному проекту попросили сделать :))) Тоже до этого ни разу не сталкивалась.
techwriter.ru.com
 
Цитата
ADVANCED пишет:
Методички и учебные пособия на курсах будут, но там смесь тех.док и маркетинга и делают такие доки не писатели.
Технические писатели их и делают во всех развитых странах.
techwriter.ru.com
 
Цитата
Марина пишет:
У нас обычно под работой по 34 госту подразумевается разбиение проекта на этапы
1) техническое задание
2) технический проект
3) рабочая документация (2 и 3 часто объединяют)
4) ввод в действие
Если на то пошло, то писателю можно развиваться в направлении разработки проектной документации и расти к Системному или Бизнес-аналитику. Напомню, что ТЗ относится к проектной документации, а технический писатель может выступать в роли аналитика, только если есть знания, нывыки или желание. Но это не совсем правильно.

Цитата
Марина пишет:
Для конечного пользователя из этих документов предназначено полтора, и никакой гост не запрещает кроме них сделать ещё и онлайн-хелп.
Есть пример красочного сайта технического задания по ГОСТ34?  :)  


Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Методички и учебные пособия на курсах будут, но там смесь тех.док и маркетинга и делают такие доки не писатели.
Технические писатели их и делают во всех развитых странах.
Что-то мне подсказывает, что не технические писатели это делают ;) . Я подобным занимался лет 8 назад и назывался "специалист по подготовке учебных материалов и презентаций". Не нужно было вдаваться в подробности программной логики и функционала, описывались только юзкейсы, при этом нахваливая программу.  
 
Цитата
ADVANCED пишет:
Что-то мне подсказывает, что не технические писатели это делают  ;)  . Я подобным занимался лет 8 назад и назывался "специалист по подготовке учебных материалов и презентаций".
Тоже самое делал, а назывался техписом, хотя и работал в учебном отделе), обучали пользователей работе с программой., но если говорить по теме развития технического писателя как специалиста, то почему бы ему не владеть такими навыками? Очень даже полезно
 
Цитата
writer пишет:
если говорить по теме развития технического писателя как специалиста, то почему бы ему не владеть такими навыками? Очень даже полезно
Да, полезно. Но речь была в сообщении про ГОСТ и печатную документацию  ;) , что является бесполезным как навыком, так и занятием.
 
Цитата
ADVANCED пишет:
Цитата
Марина пишет:
У нас обычно под работой по 34 госту подразумевается разбиение проекта на этапы
1) техническое задание
2) технический проект
3) рабочая документация (2 и 3 часто объединяют)
4) ввод в действие
Если на то пошло, то писателю можно развиваться в направлении разработки проектной документации и расти к Системному или Бизнес-аналитику. Напомню, что ТЗ относится к проектной документации, а технический писатель может выступать в роли аналитика, только если есть знания, нывыки или желание. Но это не совсем правильно.
Я писала выше, я примерно туда и развиваюсь  :)  И должность у меня называется "аналитик", а фактически 2 в 1, тех. писатель + аналитик. Но там, где должности разделены, мне кажется, всё равно все документы должны проходить через тех. писателя. Общая грамотность текстов, единство стиля, оформление - это все его работа.

Цитата
ADVANCED пишет:
Есть пример красочного сайта технического задания по ГОСТ34?  :)  

Не поняла вопрос. Сайта, ТЗ к которому писалось по 34 госту?
Страницы: 1 2 3 4 5 След.
Читают тему