Size: a a a

technicalwriters

2021 January 20

AD

Alyona Devon in technicalwriters
да речь не о том, на кого повесить ответственность (отдельно по тех документации нет тим лида и относится тех райтер к отделу маркетингу. не может человек так сильно вникать во все спектры маркетинга по функциями наверное. и то иногда документация это ближе к разработке, чем к маркетингу) а о верной структуре ТЗ тех райтеру, обязательные моменты что ли. я просто очень часто встречаю тут в чате, что мол задача приходит полной - бери и пиши. интересно просто как это)

ну по предыдущему функционалу было все доволи просто. просто это что-то новое и большое добавляется, думаешь с какой стороны подойти и как подать. или с какой стороны вообще хотят подать и задачу пишет хоть тот кто этот функционал видел/открывал)
источник

AD

Alyona Devon in technicalwriters
компания компании рознь, я помогаю еще одному стартапу и после работы писала ТЗ на дизайнера чтобы составил дизайн для таблиц и вставки кода. вставила примеры, просчитал отступы, затем перевести это на верстальщика и потом бекендеру чтобы в cms добавить кнопки. ведь писать все последующие буду не я, которая могу и сверстать статью, а копирайтер +это хорошо оптимизирует и ускоряет процесс

хотя вроде как должна была только написать статью. а не продумать еще и такие моменты. хотя хз где там начинаются и заканчиваются границы обязанностей
источник

AD

Alyona Devon in technicalwriters
к примеру я когда пришла на свое основное место все эти моменты были уже сделаны
готовые кнопки - бери и вставляй. все просто

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

F

Fagor in technicalwriters
Alyona Devon
да речь не о том, на кого повесить ответственность (отдельно по тех документации нет тим лида и относится тех райтер к отделу маркетингу. не может человек так сильно вникать во все спектры маркетинга по функциями наверное. и то иногда документация это ближе к разработке, чем к маркетингу) а о верной структуре ТЗ тех райтеру, обязательные моменты что ли. я просто очень часто встречаю тут в чате, что мол задача приходит полной - бери и пиши. интересно просто как это)

ну по предыдущему функционалу было все доволи просто. просто это что-то новое и большое добавляется, думаешь с какой стороны подойти и как подать. или с какой стороны вообще хотят подать и задачу пишет хоть тот кто этот функционал видел/открывал)
знаете я вообще на другом уровне работаю, неопределенность даже интересно, вопрос денег и полномочий. Если их нет, она выматывает, если есть и то и другое — добавим время, и мы растем и все отлично. Я к чему, четкие задачи — скука и отсутствие роста. НО если за ресеч не платят, нет времени и полномочий принятия решения, просто меняйте работу.
источник

F

Fagor in technicalwriters
меня жутко бесят разработчики которые требуют инструкций до уровня тупо за кодить. А не принятие решения как исходя из описания что нужно, а не как нужно.
источник

AD

Alyona Devon in technicalwriters
да что все сразу предлагают менять работу.) мне ж интересно как верно и построить это
это ж каждый день что-то новенькое, развитие какое) (просто иногда не знаешь куда развиваться то)

я сама выучила и как писать гайды и как писать документацию посложнее
сейчас вопрос уже второй - про налаживание процессов. и полномочий у меня достаточно)
источник

AD

Alyona Devon in technicalwriters
дизайн интерфейса он очень хорошо продуман. все доволи интуитивно
клиенты сами так и говорят сравнивая с другими

по большому счету там даже гайды не нужны. вот вообще (поэтому их иногда скучно писать)

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

H

Hartmann in technicalwriters
Alyona Devon
да что все сразу предлагают менять работу.) мне ж интересно как верно и построить это
это ж каждый день что-то новенькое, развитие какое) (просто иногда не знаешь куда развиваться то)

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

AD

Alyona Devon in technicalwriters
Крупные компании тоже не панацея)
Интересно кстати что у дропбокса случилось
интересный способ узнать про офферы различных компаний)

https://www.linkedin.com/feed/update/urn%3Ali%3Aactivity%3A6755841147819630592/?commentUrn=urn%3Ali%3Acomment%3A%28activity%3A6755566809006542848%2C6755836488866426880%29

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

AD

Alyona Devon in technicalwriters
Hartmann
По всей видимости, потому, что нерационально заниматься подобным и тратить своё время и жизнь на это, не получая, как минимум, хорошего материального вознаграждения.
Как правильно заметили выше: если за ресёрч не платят, нет времени, если таски ставят таким образом, что это выглядит, как подачка, будто собаке кость швырнули (и на ваши замечания по поводу некорректности такого подхода никак не реагируют), то да — однозначно повод задуматься о перспективах своего дальнейшего нахождения на конкретной должности в подобной «чудо-компании».
почему сразу «кость швырнули») при приеме сразу сказали что первое требование - самостоятельность. Сама расписывай, ищи, думай, бери ответственность и тд)

Для разнообразия интересно было бы конечно поработать там где все налажено. Но боюсь как выше сказали это будет «скучно»
источник

AD

Alyona Devon in technicalwriters
я не первая, другие значит справлялись. правда ненадолго их хватало) и из техрайтинга они вообще ушли

Я тоже думаю, что если буду переходить - то уже в дизайн.
источник
2021 January 21

M

Maeg in technicalwriters
Alyona Devon
это и есть задача от руководителя..
я надеялась что  менеджер по продукту хоть поресечит и тогда напишет

скажем так есть конструктор сайтов, в нем 9 элементов, на каждый элемент свои настройки, у этих настроек еще настройки.
делать одну статью на все многоуровневым h2 h3 h4 h5 и назвать одним названием "как создать сайт" как-то не ок.
а делить все по одному - так каждая из них сильно маленькой выйдет (обычно на каждый элемент и была отдельная статья, но сейчас сложно назвать это полноценным чем-то, вводных очень мало и некоторые элементы между собой зависимы)

далеко не все элементы нужны всем сайтам, как и не все настройки

ну то такое, я еще подумаю над структурой и темами.

мне просто интересно как должно выглядеть ТЗ, не могу же попросить того чего не знаю как писать сама)
может есть какие-то стандарты

я то привыкла к ним, доволи давно уже ж. но в посл время начала уставать немного, ведь никто не выделяет отдельно время на продумывание идеи - а это ресурснозатратно.
в общем раньше казалось норм за день проверить, придумать, написать и опубликовать. а сейчас "бобик сдох")
и понимаю что пора приниматься за оптимизацию и налаживание процессов.
стандарты - это то, что подходит всем в общем и не подходит никому в частности :)
Ну и я б не говорила о стандарте на ТЗ, а упростила бы до типового списка входящих данных на постановку задачи. Всякие там "компонент", "разработчик\эксперт\другое контактное лицо", "срочность\дата дедлайна",  чего вам обычно не хватает?
1. Выписать список уточняющих вопросов по этому конкретному заданию.
2. Пройтись по нескольким предыдущим заданиям - покрывает ли этот список все входные аспекты?
3. Согласовать этот чек-лист с руководством. Оповестить тех, кто обычно ставит задачи. Оптимально - внедрить в тикетницу.
4. Не удивляться, если всё равно будут писать "на усмотрение техписа" :) Имхо, уж по организации структуры статей техпис должен принимать решения самостоятельно или с коллегами. У остальных могут быть разве что пожелания :)
источник

AD

Alyona Devon in technicalwriters
Maeg
стандарты - это то, что подходит всем в общем и не подходит никому в частности :)
Ну и я б не говорила о стандарте на ТЗ, а упростила бы до типового списка входящих данных на постановку задачи. Всякие там "компонент", "разработчик\эксперт\другое контактное лицо", "срочность\дата дедлайна",  чего вам обычно не хватает?
1. Выписать список уточняющих вопросов по этому конкретному заданию.
2. Пройтись по нескольким предыдущим заданиям - покрывает ли этот список все входные аспекты?
3. Согласовать этот чек-лист с руководством. Оповестить тех, кто обычно ставит задачи. Оптимально - внедрить в тикетницу.
4. Не удивляться, если всё равно будут писать "на усмотрение техписа" :) Имхо, уж по организации структуры статей техпис должен принимать решения самостоятельно или с коллегами. У остальных могут быть разве что пожелания :)
я какой вопрос не "придумаю"
(а я думаю и как пользователь. самый такой противный и изощренный, меня пользователи этому научили, когда на их запросы отвечала. в общем тестировщик обзавидуется моим юзер кейсам))
и как маркетолог, все таки в команде маркетинга, каждый день митинги с маркетологами. они все про сео говорят,правильные вступления и прочие задачи такого плана, и я себе на ус мотаю)
то сама же знаю ответ. или знаю где/как найти ответ. в общем среди всех маркетологов больше всех подкована техническески и информационно хотя бы потому, что меня еще включили в процесс разработки UX продукта и для меня на момент написания статьи просто не может быть "белого пятна"..

не знаю почему сейчас случилась "внутренняя истерика" или то сильно отдыха хочется) и вот хочется стандартизировать что ли.
просто сейчас навалилось сразу 6 новых релизов. и все они очень крупные и масштабные. и когда в очередной раз получила эту таску, во время работы над другими что-то во мне сломалось.
спасибо за ваш чеклист, попробую вспомнить свой опыт и составить свое идеальное ТЗ

по апи и интеграциям легче всего, они все похожи друг на друга и там уже "научились" мне сразу давать, раз я одни и те же вопросы задаю.

а вот по продукту в UI спектре, то есть через кнопки в личном кабинете пользователя..все совершенно разное и понятное. остается только составить этот юзер флоу и провести по нему юзера попутно отвечая на все вопросы которые могут возникнуть

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

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

итак
1. их может быть 1001 и я на все знаю ответ. даже больше чем каждый отдельный член в компании, так как успела в ходе разработки текста-дизайна пройтись по тестировщикам, разработчикам, дизайнерам и маркетологам
2. каждое задание не похоже на предыдущее, так как продукты совершенно разные в использовании)
3. да согласны почти на любой каприз)) все что не предложу - давай, делай или ставь задачу чтобы сделали. любой каприз кроме добавления еще человека или повышение зп)))
4. ну да, иногда на этом и заканчивается - я спрашиваю "а это точно нужно", "а это нужно", "а лучше так или так" - на меня смотрят круглыми глазами и в ответ - так ты ж тех писатель, ты и решай =)
ясно-понятно. включается синдром самозванца и просто страшно иногда принимать окончательные решения
но никто от них еще не умер,)
источник

AD

Alyona Devon in technicalwriters
Все возможные лимиты/ограничения и подсказки по элементам, что за чем уже есть в интерфейсе - сама же писала и переводила, поэтому не остаётся места даже таким узким вопросам)
источник

NV

Nick Volynkin in technicalwriters
Katy
#wanted_tw
Ищу второго техписа в команду (я - первый).
В основном мы поддерживаем документацию всех продуктов Aurea Unlimited и GFI. Объем зависит от продукта - от редких релиз ноутов до регулярных обновлений с новыми фичами. Периодически портфель расширяется - тогда приемка и импорт документации. Работа в основном в MadCap Flare и OxygenXML в зависимости от проекта.

Условия работы: удаленно, 40 активных рабочих часов в неделю (перерывы не учитываются). 15$ час, часовой пояс значения не имеет; отпуск, больничный не оплачивается. Компания: Crossover.com
Требования: английский Upper Intermediate, прохождение теста CCAT не ниже 35. Очень желателен опыт работы техническим писателем и опыт работы - новички не справляются.  

Если интересно, пишите мне.
С уважением, Екатерина
>  40 активных рабочих часов в неделю (перерывы не учитываются).

А как у вас это отслеживают? Трекер делает скриншоты экрана каждые 5 минут?
источник

NV

Nick Volynkin in technicalwriters
Alyona Devon
это и есть задача от руководителя..
я надеялась что  менеджер по продукту хоть поресечит и тогда напишет

скажем так есть конструктор сайтов, в нем 9 элементов, на каждый элемент свои настройки, у этих настроек еще настройки.
делать одну статью на все многоуровневым h2 h3 h4 h5 и назвать одним названием "как создать сайт" как-то не ок.
а делить все по одному - так каждая из них сильно маленькой выйдет (обычно на каждый элемент и была отдельная статья, но сейчас сложно назвать это полноценным чем-то, вводных очень мало и некоторые элементы между собой зависимы)

далеко не все элементы нужны всем сайтам, как и не все настройки

ну то такое, я еще подумаю над структурой и темами.

мне просто интересно как должно выглядеть ТЗ, не могу же попросить того чего не знаю как писать сама)
может есть какие-то стандарты

я то привыкла к ним, доволи давно уже ж. но в посл время начала уставать немного, ведь никто не выделяет отдельно время на продумывание идеи - а это ресурснозатратно.
в общем раньше казалось норм за день проверить, придумать, написать и опубликовать. а сейчас "бобик сдох")
и понимаю что пора приниматься за оптимизацию и налаживание процессов.
Маленькие атомарные статьи — это нормально и даже хорошо. Они легче читаются и лучше ищутся в поисковиках.

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

F

Fagor in technicalwriters
Оффтопну, хочу статьи на корп. портале (обязательно перекречтные с первой): Как уволится, найти дело прибыльное "по душе", и зажить счастливо!
источник

L

Lana in technicalwriters
Alyona Devon
у кого-то есть пример тз на статью базы знаний?
то когда я говорю что у меня задачи никогда не расписываются что там должно быть, кто-то не поверил. но почему-то примеры не дали

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

https://monosnap.com/file/QjEaUF1Yix7fI9BfsNeNh77QCwZeln
У нас в базе есть инструкция как поставить задачу техпису, там явно указано без какой информации задача уйдёт на уточнение, а что nice to have + хорошая практика настроить шаблон задачи, чтобы сразу в описание вставился текст - опиши тут то, добавь ссылки на это.
источник

MS

Maria Shabanova in technicalwriters
Lana
У нас в базе есть инструкция как поставить задачу техпису, там явно указано без какой информации задача уйдёт на уточнение, а что nice to have + хорошая практика настроить шаблон задачи, чтобы сразу в описание вставился текст - опиши тут то, добавь ссылки на это.
У нас есть прям готовый шаблон в задачах, по которому можно ставить задачи на наш отдел (разработки). Вот тебе пункт 1, вот 2. Но разве же им кто-то пользуется? =/
источник

Ю

Юлия in technicalwriters
Nick Volynkin
>  40 активных рабочих часов в неделю (перерывы не учитываются).

А как у вас это отслеживают? Трекер делает скриншоты экрана каждые 5 минут?
Скорей, каждый раз нужно отчитываться о времени над задачей или что ты сделал за день в какой-нибудь приложухе.
Но это такое себе...
Потому как это влечет за собой тотальный контроль и моментальные "письма счастья" если, например, не все время списал...написал 7.5 часов вместо 8 и на почте на след день уже "радостные вопли" о нехороших работниках))
источник