в моем понимании, это кастрированные сисадмины, которые более универсально подкованы и не заточены подо что-то одно. не?
плохо выразился. не сисадмины кастрированные, а наоборот
Много чего. Вы бы как-то уточнили, что именно хочется узнать?
А так — профессия нужная, но редкая. В основном люди привлекаются к написанию внешней документации (иногда пользовательской, иногда — что сложнее — для технических специалистов).
Как правило, выделенных технических писателей привлекают компании имеющие собственный продукт (в заказной разработке редкость).
В России определенный рынок есть, но, судя по всему, не очень большой.
Помню, что было даже пара русскоязычных сообществ — поищите, наверняка там будет полный ответ на ваши вопросы.
Re[2]: Технический писатель - что думаете об этой профессии?
МР>А так — профессия нужная, но редкая. В основном люди привлекаются к написанию внешней документации (иногда пользовательской, иногда — что сложнее — для технических специалистов). МР>Как правило, выделенных технических писателей привлекают компании имеющие собственный продукт (в заказной разработке редкость).
кстати, может объяснишь, почему она в своем большинстве такого плохого качества?
вроде и писать текст умеют, и вроде технический склад ума, но если рассматривать что вижу в российском секторе по толковости сильно уступает зарубежным аналогам (что там в Китае творится в этом плане могу только гадать)
Re[2]: Технический писатель - что думаете об этой профессии?
МР>Как правило, выделенных технических писателей привлекают компании имеющие собственный продукт (в заказной разработке редкость).
Ну я бы не сказал, что такая уж редкость.
В заказной разработке очень часто встречаются требования наличия документации в соответствии с какими-то стандартами (в нашей стране обычно по ГОСТам, но возможны и другие варианты).
И вот тут технические писатели очень нужны (хотя должность формально может даже называться не "технический писатель", а какой-нибудь "инженер 1-й категории", но фактически человек работает как технический писатель).
И еще один нюанс — обычно технические писатели не сами из головы выдумывают что писать. Чаще бывает так: программист или проектировщик дает техническому писателю свои материалы в вольном изложении, а технический писатель уже их причесывает, структурирует и оформляет как надо.
Re[3]: Технический писатель - что думаете об этой профессии?
Здравствуйте, nikkit, Вы писали:
N>кстати, может объяснишь, почему она в своем большинстве такого плохого качества?
Экономят, навешивая написание документации как бы между делом
Re[4]: Технический писатель - что думаете об этой профессии?
Вообще писатели разные нужны. Работы невпроворот. У меня на работе большущий отдел пишет сотни страниц ежедневно с шаблонами, специально заточенными под это программами, с планом документов итд. Сейчас ещё и локальный чатик на LLaMa пытаются ко всему этому добру припахать.
Но сам я писать не очень люблю. Плюс там желательно владеть английским, лучше, чем любыми другими языками.
Re[5]: Технический писатель - что думаете об этой профессии?
M>>Экономят, навешивая написание документации как бы между делом
N>а что они еще делают, если занимают позицию "технический писатель"? мебель собирают?
Вопрос был "почему тех документация в большинстве такого плохого качества?". При чем тут техписатели?
Re[3]: Технический писатель - что думаете об этой профессии?
N>кстати, может объяснишь, почему она в своем большинстве такого плохого качества? N>вроде и писать текст умеют, и вроде технический склад ума, но если рассматривать что вижу в российском секторе по толковости сильно уступает зарубежным аналогам (что там в Китае творится в этом плане могу только гадать)
Что такое документация в российском секторе? Документация для продуктов, которые продаются только в РФ?
По моему опыту внешняя документация (без привязки к странам) бывает плохого качества по следующим причинам:
1) тех. пис. плохо понимает тему, а время на то, чтобы исправить все ошибки вместе с разработчиками продукта, ограничено
2) документация отстала от разработки продукта, а обновить нет времени или просто забыли
3) алгоритм работы продукта очень нетривиальный/кривой, и описать его на человеческом языке без смысловых потерь непросто (псевдо/кодом проще)
4) продукт имеет слабые стороны, но честно их описать в документации нельзя по маркетинговым соображениям (при этом совсем не писать о проблемах нельзя, т.к. нужно на что-то сослаться, если enduser будет недоволен)
Re[4]: Технический писатель - что думаете об этой профессии?
M>По моему опыту внешняя документация (без привязки к странам) бывает плохого качества по следующим причинам: M>1) тех. пис. плохо понимает тему, а время на то, чтобы исправить все ошибки вместе с разработчиками продукта, ограничено M>2) документация отстала от разработки продукта, а обновить нет времени или просто забыли M>3) алгоритм работы продукта очень нетривиальный/кривой, и описать его на человеческом языке без смысловых потерь непросто (псевдо/кодом проще) M>4) продукт имеет слабые стороны, но честно их описать в документации нельзя по маркетинговым соображениям (при этом совсем не писать о проблемах нельзя, т.к. нужно на что-то сослаться, если enduser будет недоволен)
Дополню еще:
5) Документация недостаточно была задействована в процессе тестирования
a) не тестировали саму документацию: точно ли получится сделать то, что надо, если следовать документации.
б) не тестировали покрытие документацией: все ли важные нюансы расписаны в документации
Re[2]: Технический писатель - что думаете об этой профессии?
K>Дополню еще: K>5) Документация недостаточно была задействована в процессе тестирования K> a) не тестировали саму документацию: точно ли получится сделать то, что надо, если следовать документации. K> б) не тестировали покрытие документацией: все ли важные нюансы расписаны в документации
в) нахрен ему это все вообще уперлось
Re[7]: Технический писатель - что думаете об этой профессии?
M>>Вопрос был "почему тех документация в большинстве такого плохого качества?". При чем тут техписатели?
N>А Кто еще занимается ей, беря в штат технического писателя?
Когда она херовая, как правило ей занимаются разработчики по остаточному принципу
Re[3]: Технический писатель - что думаете об этой профессии?
МР>>А так — профессия нужная, но редкая. В основном люди привлекаются к написанию внешней документации (иногда пользовательской, иногда — что сложнее — для технических специалистов). МР>>Как правило, выделенных технических писателей привлекают компании имеющие собственный продукт (в заказной разработке редкость).
N>кстати, может объяснишь, почему она в своем большинстве такого плохого качества?
Не знаю.
У меня есть некие соображения, но и только.
1. У нас в целом большAя часть специалистов (не только технических) с очень большим трудом умеет изложить свои мысли просто и доступно.
И здесь, как мне кажется, основная проблема, что в нашей образовательной системе этот навык систематически не тренируется. Т.е., что в школе, что в вузе мы пишем сочинения, рефераты, но... пишем их достаточно шаблонно.
А всякие курсовые, дипломные, ... — которые делают большинство студентов это какой-то кошмар: один сплошной канцелярит, да еще и по строгому шаблону.
Ну и большинство учебников для ВУЗа кажется написаны по принципу "давайте напишем даже о простом на столько непонятно, чтобы никто не сомневался в нашей гениальности и даже не пытался понять ,что мы тут изложили".
Откуда тут возьмутся люди, умеющие легко и изящно объяснить что-либо? Да неоткуда им взяться.
А вот в той же английской и американской системах образования (про остальные просто не знаю) весьма популярно написание эссе. Т.е ровно то, о чем мы говорим: небольшой текст, где своими словами, простым языком изложить произвольную тему: философскую, техническую, ... — не важно, главное что формируется навык изложения своих мыслей в доступной для читающего форме.
Да они тоже не на 100% справляются, но у них, по крайней мере, есть какая-то база. Наши же письменные работы — это именно шаблоны за редким исключением.
2. Работа над документацией — это жутко тягомотная и рутинная работа.
Нужно кропотливо отслеживать изменения в продукте, по многу раз переписывать одни и те же разделы, обновлять скриншоты, ...
Т.е. это даже не техническая книга, над которой может быть реально интересно работать. Это тяжелая, нудная и кропотливая работа!
Конечно же, в случае наличия иных возможностей, мало кто будет стремиться идти в технические писатели.
3. При этом, если мы говорим не о пользовательской, а технической документации, её разработчик должен иметь достаточно глубокое понимание предмета. Даже придумать хорошие тестовые примеры для демонстрации некоего API — та еще задачка.
И получается, что тех, кто способен хорошо изложить материал не так и много (не готовим), а те кто есть могут найти себе куда более интересное (и денежное) занятие.
Re[3]: Технический писатель - что думаете об этой профессии?
Здравствуйте, klopodav, Вы писали:
МР>>Как правило, выделенных технических писателей привлекают компании имеющие собственный продукт (в заказной разработке редкость).
K>Ну я бы не сказал, что такая уж редкость.
Не буду спорить, это исключительно мои наблюдения по всего лишь одной компании (т.е. репрезентативность та еще...)
У нас отдел технических писателей был, но:
— я ни на одном из проектов с ними не пересекался
— относительно остального состава фирмы ребята просто терялись (т.е. по количеству шли как-то так: разработчики, тестировщик, аналитики, девопс/админы, дизайнеры, разные узконаправленные специалисты (типа DBA), тех. писатели),
Т.е. подавляющее число проектов обходилось без выделенных тех. писателей.
Зато в 2-х продуктовых где я работал такие отделы были (причем, я искренне считаю, что у одной из компаний документация практически образцовая была), а в третьей шел процесс формирования такового (там компания очень бурно росла и просто не успевала за всем).
Re[3]: Технический писатель - что думаете об этой профессии?
хватит, а вот на жирную шавуху уже нет.
Ничего сказать не могу.
Я исхожу из того, что те продуктовые, где я успел поработать, периодически технических писателей в штат искали.
Но на темы:
— где они это делали?
— как находили людей?
— какие были/есть зарплаты?
Ничего сказать не могу.
Re: Технический писатель - что думаете об этой профессии?
1) скорее всего LaTeX, для того, чтобы делать .pdf-документы.
2) хорошо бы ещё уметь делать HTML (можно через какой-нибудь texinfo)
3) уметь рисовать .svg в Inkscape, чтобы везде их вставлять
(хорошо бы ещё уметь делать скриншоты в .svg, но это надо сильно заморочится с софтом)
4) рисовать вообще полезно ещё в 3D, т.е. blender и freecad, иллюстрации всякие.
5) уметь в переводы, в том числе автоматизированные.
Т.е. владение https://www.transifex.com , translation memory и т.п.
Посмотрите на лидеров рынка вообще и автоматически переведённую документацию Microsoft в частности.
Т.е. там дофига скиллов, и ни в какой школе такому не учат.
Ну и само составление текстов тоже скилл, там же стили разные, терминология, стандарты
(надо не только знать о существовании ГОСТ 19 и 34, но и иметь к ним шаблоны для всех программ,
шрифты специальные и т.д.)
