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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Сомневаюсь в значимости должности техписа в конкретной компании - как быть?
 
Всем добрый день!
Почти год я работаю техническим писателем в крупной фирме (ПО, информационные технологии, но с одним направлением). Профессия новая для меня, хотя с текстами я имею дело лет с 15 (журналистика печатная и электронная, копирайт, сео, блоггерство, тексты из научной сферы). Работать техписом мне нравится, я хочу в ней развиваться насколько могу.

НО! Создалась странная ситуация в данной компании: я подозреваю, что работа техписа им не особо нужна.
Год назад меня взяли под конкретный крупный проект (большие обновления, связанные с одним из сайтов). К слову, трудовой договор был заключен бессрочный. Я переписала старое руководство, добавила всяких фич, навигации, удобной структуры. Делала дополнительные задачи, use-case, оформляла тексты html. По окончании проекта меня похвалили, все одобрили, все ок. Но - что делать дальше? Мой непосредственный начальник (ПО МОЕЙ ПРОСЬБЕ) поручил аналитикам дать мне новых задач, они это сделали, но, честно говоря, как-то на отвяжись. Словно актуальная документация нафиг не нужна - сойдут и старые инструкции без обновлений, с пунктуационными ошибками, с коряво построенными предложениями и т.д. Руководства висят на официальном сайте в свободном доступе, но, кажется, всем все равно. Только для одного из сайтов захотели сделать актуальное читабельное руководство - ну, и всё. Главное же - это работающие программы, то есть деятельность программистов и аналитиков.
В связи с этим я терзаюсь, что начальство действительно сейчас решит, что техпис им не нужен и попросит написать заявление.

Как вы думаете, насколько мои опасения обоснованы, часто ли подобные ситуации между фирмой и техписом возникают?

PS ГОСТы и другие стандарты данная компания не использует, я пишу только руководства пользователей (их структура соответствует пользовательской документации по ГОСТу 19), периодически описываю обновления (можно сказать, делаю use-case). ГОСТы, IEEE и прочее изучаю сама как могу. На всякий случай иногда хожу на собеседования.

PSS так как мой начальник (а также большинство аналитиков) сидит в Москве, а я в Питере, то я редко могу с ним лично поговорить. Как раз через пару недель такая возможность предоставится. Я хочу с ним обсудить вопрос, почему аналитики и оунеры, видя проблемы с руководствами или описаниями задач, мало со мной контактируют, порой не отвечают на сообщения, не проверяют или очень вяло проверяют мою работу. Возможно, это я  плохо иду на контакт или медленно работаю. Может, дело не в конкретных людях, а в неотлаженной системе.
Изменено: polina_filolog_tw - 23.07.2018 14:39:41
 

Добрый день.

Я вижу как минимум две причины.

1-е По поводу «мало со мной контактируют, порой не отвечают на сообщения, не проверяют или очень вяло проверяют мою работу»  - возможно им просто некогда проверять за вами вашу работу или придумывать вам задание. К слову, задания вам должен все-таки выдавать ваш руководитель, а не другие сотрудники. Если есть система ведения задач, то максимум, что они могут делать (как мне кажется) накидать туда задач для вас: исправить там-то , переделать то-то.

2-е: по моему опыту могу сказать, очень часто  вот эти внутренние инструкции, криво написанные руководства, в которых нет содержания , ссылок и прочих удобств- пишутся наскоро, используются сотрудниками один раз (первый), далее все-всё знают и в руководстве не нуждаются. Эти документы лежат так: на случай прихода нового сотрудника или когда потребуется что-то освежить в памяти.

Для того чтобы это реально все перелопатить и перевести в божеский вид, нужны ресурсы - в том числе ресурсы технических специалистов (программистов/аналитиков) (потому что какие-то процессы устаревают, что-то меняется в программе) и вы конечно можете что-то поправить, но все равно нужно чтобы кто-то просмотрел итоговый вариант. А соответственно это затраты,  т.е. технарь должен выделить на это время, отодвинув свою работу. А компания это время должна оплатить. А так как это внутренние работы – только для красоты и прибыли как таковой от красиво написанной инструкции нет, поэтому никто не заморачивается.

Но в моей практике были и ситуации, когда небрежно написанная инструкция приводила и к реальным затратам компании. Потому что эта кривая инструкция выдавалась, например подрядчику, подрядчик делал, так как он понял, а потом выяснялось, что в инструкции подразумевалось несколько другое. Но так как коряво написано, то доказать ничего нельзя. Либо термин был описан криво- и на сдаче-приемке работ, заказчик цеплялся к нему и говорил: а я вот это понял так и сделайте мне так, потому что когда я платил, я думал, что плачу за то, а не за это.

И меньше всего, я бы вела диалог с руководителем в ключе « а вот они такие-сякие не дают мне работу». А они должны обеспечивать вам загрузку? Это предусмотрено в их должностных инструкциях? У них выделено на это время? Структура организации обязывает их выдавать вам задание? Потому что если они не обязаны это делать - вы просто испортите отношения с ними.

Лучше вести разговор в ключе: я составила план, могу сделать вот это и вот это, а потом могу переключиться еще на какие-то задачи, давайте определим на какие ( и  предложить - если у вас есть пользователи- может для них нужно обучающие презентации сделать, может тем же аналитикам нужно помочь в оформлении презентаций).

В вашей ситуации, если у вас есть желание, возможно вам стоит попробовать себя как начинающий тестировщик. К сожалению, непонятно чем именно занимается компания, но если вы можете тестировать как пользователь, то вполне можете выполнять эту работу с параллельным исправлением документации.

Вот как-то так, удачи!

 
О, как я вас понимаю! У самой такая же ситуация... :-(
Но как по мне так выход один - для собственного роста переходить в пользовательскую документацию, причем активно используемую (Яндекс как пример), т.к. документация по ГОСТ пишется часто как отчётная для галочки и после утверждения её никто не читает.
И даже больше - стать не чисто техписом по работе с текстами, а кем-то, кто делает интерфейсы дружественными: меняет структуру интерфейса, порядок элементов, их вид, упорядочивает типизацию и делает её интуитивно понятной и т.д. - хотя это, наверное, больше к дизайнерству относится.
Потому что обычные пользователи (не на АЭС или в военной отрасли, а те, кто пользуется вордом, приложением в телефоне и т.п.) действительно очень редко читают документацию. Да и зачем им это? К документации обращаются лишь интроверты, которым проще полазить на сайте в поисках подходящего FAQ (т.е. точечно узнавать ответ только на интересующий вопрос), чем звонить в техподдержку, а объёмные фолианты, хоть и хорошо структурированные - и их отпугнут. Соответственно, большие объёмы документации действительно имеют очень низкий приоритет.
А вот создание интуитивно понятного интерфейса - действительно нужная вещь. По части техписательства от этого остается разве что написание контекстной справки...

По вашей ситуации мои мысли следующие:

1) "начальство действительно сейчас решит, что техпис им не нужен и попросит написать заявление" - а у вас часто увольняют в компании? думаю, если им пофиг на документацию, то и на трату денег на ЗП "ненужному" сотруднику тоже пофиг и никто не будет об этом заморачиваться, если у фирмы нет серьёзных финансовых проблем и не предстоят сокращения. Если же предполагаете, что такое действительно может случиться и не хотите этого, то продолжайте делать свою работу - тогда и придраться к вам будет нельзя, уцепиться не за что и увольнять будут других, менее иницитивных.
2) "почему аналитики и оунеры, видя проблемы с руководствами или описаниями задач..." - если честно, не думаю, что они их действительно видят :-) у вас, как у человека, профессионально занимающегося текстами, глаз намётан и такие ошибки вам этот глаз режут, а они их просто пропускают, даже не заметив. Плюс у них есть своя работа и вникать или советовать что-то улучшить коллеге другого профиля - многие или не заморачиваются с этим или считают это нарушением субординации/проф этики. По этой же причине они "мало со мной контактируют, порой не отвечают на сообщения, не проверяют или очень вяло проверяют мою работу" - конкретно на вашу работу им действительно всё равно. Возможный выход: брать на себя ответственность за определённые решения по документации, разобраться, что точно в компетенции аналитиков и оунеров и задавать им максимально конкретные вопросы, ответы на которые отражать в документации, и просить проверять постфактум.

Самое важное, это то, что вы там одна :-( если бы с вами было бы ещё хотя бы два-три техписателя, то и работа была бы живее, вы бы между собой активно спорили, разрабатывали бы стайлгайды, методики, шаблоны, какой-то стиль и подходы. А так вы варитесь в собственном соку. Как и я сейчас :-(

Попробуйте перейти сами в другую компанию, в которой будет побольше техписов и где вы будете заниматься именно пользовательской документацией. Правда, сотрудники, занимающиеся такой документацией, часто не техписами являются, а сотрудниками техподдержки, соответственно ЗП, возможно, меньше и, наверное, не избежать нервотрёпки непосредственного общения с пользователями по телефону.
 
Добрый день! спасибо за ответ.

Да. Им, скорее всего, действительно некогда работу проверять, это я прекрасно понимаю. Но по идее, работа техписа - такая же часть общей работы, как и то, что делают программисты или те же тестировщики - то есть тут нужен контроль и проверка. Не каждый день и даже не всегда каждую неделю, но обратная связь должна быть. А сейчас происходит все так, будто мне одной все это надо, хотя не я эту вакансию создала  и не я стала напрашиваться на работу в эту фирму, они сами меня нашли.
Цитата
'Ася' написал:
К слову, задания вам должен все-таки выдавать ваш руководитель, а не другие сотрудники.
Сейчас сложилась такая ситуация, что большой проект, который я делала,  закончился (остались мелкие доработки) и поэтому его руководитель мне задания не дает, а руководитель по другому проекту пока толком не наметился. Начальник (не руководитель) большого отдела , который и захотел год назад, чтобы у них был тех.писатель, передал меня главному аналитику, но его пока сложно назвать моим руководителем. Дал несколько задач, объяснил, как делать, ответил на пару вопросов по ходу дела и "утонул" в своей работе, то есть замолчал.
Цитата
'Ася' написал:
И меньше всего, я бы вела диалог с руководителем в ключе « а вот они такие-сякие не дают мне работу».
Да, конечно, я ни в коем случае так не буду вести диалог, я выскажусь максимально дипломатично, так как сама понимаю, что у всех у нас своя работа и своя загруженность.

Насчет роли тестировщика подумаю - у меня подруга техпис в своей фирме выполняет обязанности в том числе тестировщика. Но полностью переходить на другую должность я не хочу, а намерена остаться техписом, просто с доп.функциями. Во время работы я вносила предложения и замечания бизнес-аналитику по работе сайта - что можно улучшить в интефейсе, он соглашался, одобрял (не ради отмазки), но все осталось как было. Даже кое-какие недочеты.

Спасибо за совет по дополнительным задачам! Надеюсь, всё будет хорошо.  
 
Добрый день ! Спасибо за ответ
Цитата
Sofya написал:
для собственного роста переходить в пользовательскую документацию, причем активно используемую (Яндекс как пример), т.к. документация по ГОСТ пишется часто как отчётная для галочки и после утверждения её никто не читает.
Это можно было бы сделать, но раз вы говорите, что за пользовательскую документацию меньше платят... я себе такого позволить не могу, так как полностью завишу от себя, а тут еще ипотека и прочие траты wall-smile как дополнительный навык пользовательскую документацию стоит освоить - вообще, учитывая, какие разные запросы у работодателей к техпису, надо бы освоить какие только можно навыки по текстам и работе с интефейсом - от help-справок до технических паспортов.

PS стоп, пользовательская документация - это и есть то, что я сейчас делаю. Большие руководства пользователей! Из иной документации - только описание обновлений. На зп не жалуюсь, но боюсь, карьерной перспективы тут нет, даже если я как следует пошевелюсь в эту сторону... надо в этом году или в следующем постараться найти место более перспективное.

Касаемо гостов: да, делается для галочки, да, никто не читает, но формальность формальностью, а почти каждый первый работодатель хочет, чтоб ему делали документацию по гостам. Пока ситуация такова, и лучше на всякий случай освоить хоть немного, как эта формальная документация составляется. На днях мне написала одна фирма насчет работы, я отвечаю "ребята, вам нужны госты, а у меня нет такого опыта, только теория", они отвечают "ну, может , вы освежите свои знания, когда у нас появится заказчик, которому нужен гост?" то есть непросто найти того, кто работал с гостами.  
Цитата
Sofya написал:
а у вас часто увольняют в компании?
нет, нечасто, сейчас сокращений точно нет, наоборот, новые сотрудники появляются. И это, конечно, немного успокаивает, но не до конца.
Цитата
Sofya написал:
продолжайте делать свою работу - тогда и придраться к вам будет нельзя, уцепиться не за что и увольнять будут других, менее иницитивных.
да, это я и делаю сейчас, но все равно страшно. захотят избавиться - избавятся. просто попросят написать заявление и дадут отступных - за то, что хорошо работала. этого я боюсь . предполагаете, что напрасно?  help-smile сама по себе фирма надежная, официальная, все зп белые, скоро я еду на общий рабочий тренинг вместе со всеми, но..................
Цитата
Sofya написал:
Плюс у них есть своя работа и вникать или советовать что-то улучшить коллеге другого профиля -
Советов я от них как раз не жду. Только задач и их проверки, вероятно, включения в общее обсуждение этих самых задач. Зачем-то же они взяли техписа год назад на работу? Взяли меня, стали хвалить с первых же месяцев - а теперь что? Непоследовательность какая-то. Я все же надеюсь, что всё скоро исправится, особенно после разговора с начальником на встрече в Москве, и я продолжу дальше работать, а уйду только тогда, когда найду место получше  :)
Спасибо еще раз за ответ!  :)  
Изменено: polina_filolog_tw - 09.07.2018 17:44:39
 
Цитата
Словно актуальная документация нафиг не нужна - сойдут и старые  инструкции без обновлений, с пунктуационными ошибками, с коряво  построенными предложениями и т.д. Руководства висят на официальном сайте  в свободном доступе, но, кажется, всем все равно.
Ровно так и происходит в ситуации, когда текущая документации обеспечивает лишь малую дельту прибыли.

Как вариант: вы сейчас работаете на т.н. закрытых распределенных рынках. Т.е. когда прибыль компании не зависит от качества документации.

А если так - то зачем напрягаться?
 
Цитата
Текрайтер из Питера написал:
А если так - то зачем напрягаться?
Именно так.
Но зачем-то же год назад они эту вакансию создали и стали искать человека? Не я же сама к ним напросилась на техписа  :evil: я даже резюме им не отправляла, сама искали, сами позвонили, потом 2 собеседования и в промежутке - тестовое задание...   :(

Зато теперь напрягаюсь я...

...что руководство смекнет, что техпис им не особо нужен, и попросит написать заявление.
...что даже если не попросит, ни карьерного развития , ни профессионального мне здесь ждать не придется, и это серьезный повод сменить место работы, но не должность.  
Изменено: polina_filolog_tw - 18.07.2018 15:25:23
 
Рекомендую ознакомиться с данным видео (про техписов) https://www.youtube.com/watch?v=osY0bZ3wxHY - тут весьма интересно сказано про то как не дооценивают технических писателей, может появятся новые идеи.

А вообще, у нас два проекта, которые постоянно обновляются, исправляются и т.д. И мы не только пишем тексты, у нас еще локализация интерфейса (на двух пока что языках) + небольшая поддержка вики компании + мы также с тестировщиками ищем текстовые "баги" в интерфейсе, и если нет возможности исправить самим, ставим задачи на разработчиков.

И, как правило, если у нас нет задач, то мы всегда найдем что поделать - т.е. сами создаем себе задачи и активно работаем с разработчиками, аналитиками и прочими (консультация, перевод текстов и т.д.).
 
Цитата
Firniara написал:
Рекомендую ознакомиться с данным видео (про техписов)  https://www.youtube.com/watch?v=osY0bZ3wxHY
О, спасибо! С интересом посмотрю  :)

Я на той неделе сходила на собеседование, но получилось смешно: оказывается, те ребята искали аналитика, а эйчар все перепутала. Они извинились, конечно. И добавили, что работа аналитика куда более важная и высокооплачиваемая, а работа техписа- это 20% работы аналитика. То есть - не особо важная. Это везде вот так?

Цитата
Firniara написал:
+ мы также с тестировщиками ищем текстовые "баги" в интерфейсе,
угу, я этим тоже периодически занималась. Подсказывала бизнес-аналитику, что вот здесь они падеж неправильно употребили, просто скопировав текст из законодательства (а площадкой пользуются со всех концов РФ). А вот здесь торговую процедуру неправильно обозвали - на это им указали даже в казначействе; не исправили до сих пор.

Также я предлагала небольшие улучшения интерфейса: красную звездочку здесь поставить, тут разделить строки по категориям...аналитик соглашался. Что-то было  в итоге реализовано, но не факт, что оунер знал, что я там что-то подсказывала.

Наверно, мои слова выглядят как жалоба и "накатывание бочки" на других, но я правда устала от неопределенности и ощущения малоценности в данной фирме.

Из дополнительных задач я оформляла документы html-разметкой, на той неделе делала финальную корректуру регламента. Я стараюсь создавать себе доп.задачи, но пока всё устроено так, что задачи должны падать на меня сверху. Я могу что-то предложить - и предлагаю, но чертовскизанятые оунеры и аналитики даже не всегда удостаивают ответом.

Может, в течение 2 месяцев ситуация все же изменится к лучшему.  
Изменено: polina_filolog_tw - 23.07.2018 14:56:18
 
я, пожалуй, присоединюсь к идее самим ставить себе задачи. Причем такие, чтобы никого не отвлекать на них - ни разработчиков, ни аналитиков... Хотя бы по принципу "не догоню, так хоть согреюсь" )  
Например, если "площадкой пользуются со всех концов РФ" - сделать видео-инструкцию для пользователей, или несколько видео-уроков по интерфейсу. Заодно можно научиться с видео работать, говорят, это перспективно )  
Сделать красивые, понятные схемы (не скриншоты, а именно схемы, объясняющие идею, а не какую кнопочку кликать), если таких еще нет в документации. Увлекательнейшее занятие, поглощает с головой и раздвигает горизонты ) Ну и т.д.
 
Цитата
revo написал:
Сделать красивые, понятные схемы (не скриншоты, а именно схемы, объясняющие идею, а не какую кнопочку кликать), если таких еще нет в документации. Увлекательнейшее занятие, поглощает с головой и раздвигает горизонты ) Ну и т.д.
Схемы это да! Классная вещь.
Пользователь будет понимать, какие шаги ему предстоят. Проще вникать в кнопочки, когда понимаешь, зачем их клацаешь)
 
Цитата
revo написал:
я, пожалуй, присоединюсь к идее самим ставить себе задачи. Причем такие, чтобы никого не отвлекать на них - ни разработчиков, ни аналитиков...
Здравствуйте!
Честно говоря, звучит странно: ну придумала я сама себе (!) сделать схемы еще для одного руководства, для другой web-площадки, принадлежащей этой фирме, ну делаю, делаю - а им, может, это нафиг не нужно?  
Как происходит в нормальной ситуации: тебе ДАЮТ задачи и ты их делаешь, либо ты ПРЕДЛАГАЕШЬ задачи, с тобой соглашаются, ты их делаешь. Постоянная проверка тебе не нужна - максимум раз в неделю-две, в месяц. Это так напряжно?
Вместо этого я должна выдумывать себе работу, которую, возможно, никто по достоинству не оценит - ибо неактуально им это.
Опять вопрос к работодателю - зачем вы наняли техписа, если он вам не нужен. Не он же к вам напросился. Или все-таки нужен, надо только процесс отстроить?

Нет? Я не права?

Цитата
revo написал:
сделать видео-инструкцию для пользователей, или несколько видео-уроков по интерфейсу
мм......во-первых, данная фирма уже выпускала официальное видео, где описывалось, как пользоваться площадкой. Во-вторых, может, вы подскажите видео-программу, которой пользовались вы или ваши знакомые техписы? Ну на всякий случай. Я по части видео пещерный человек...

Цитата
revo написал:
Сделать красивые, понятные схемы (не скриншоты, а именно схемы, объясняющие идею, а не какую кнопочку кликать),
Почти каждый этап работы на данной площадке - этого десяток подэтапов с разными вариантами действий. Нарисованная схема действий , скорее всего, будет выглядеть запутанно и сложно.

То руководство, что делала я, я постаралась сделать максимально ясным за счет структурного текста и скриншотов: чуть ли не каждое действие описано в пунктах и занесено в отдельный подраздел, к подразделам подведена навигация. Чтобы все то же самое "нарисовать" в столь же ЯСНОМ виде...ну не знаю, надо иметь дизайнерские и чертежные способности.

Что касается объяснения ИДЕИ - это в моем руководстве тоже есть, а не просто объяснение, какую кнопочку кликать. Оунер несколько раз менял концепцию и последнее, что он хотел - чтобы в инструкции описывалось исключительно кликание по кнопочкам, но я все-таки пошла дальше и занесла туда еще и идеи, пояснения.    
Изменено: polina_filolog_tw - 24.07.2018 15:32:22
 
Коллега по работе, программист, говорит, что я сгущаю краски и советует побольше предлагать задачи самой. Достукиваться и достукиваться до оунеров и аналитиков. Плюс послезавтра в Москве я смогу поговорить с начальником, попросить у него помощи.
И повторюсь - придумывать себе работу самой, даже не предложив ее руководству, не услышав, что это НУЖНО,  более чем странно , путь в никуда, как по мне.
Страницы: 1
Читают тему