Size: a a a

technicalwriters

2020 October 22

B

Burrito in technicalwriters
тогда, вероятно, и помощь разрабов станет не нужна
источник

ДС

Дмитрий Сунцов... in technicalwriters
Alyona Devon
я 2 года занимаюсь уже документированием
и база знаний, и апи и ux райтинг

я до этого была англоязычным сапортом 3 года, то нет проблем с тестированием и английским, анализом

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

да и в общем было время идей нагенерировать, которые остались идеями

донимаю пока мне не говорят выше не трогать никого)) когда нужно будет - сами обратятся

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

каждый раз убеждаюсь. у нас вот последнюю неделю было тихо.
а вчера навалили на две недели вперёд задач))
источник

ДС

Дмитрий Сунцов... in technicalwriters
и все срочные
источник

AD

Alyona Devon in technicalwriters
да так обычно и происходит.. если нечего делать - так нечего
ну находишь себе, но это такое, что-то совсем мало приоритетное

а как приходят - так все сразу, все на вчера (у нас 6 проект менеджеров, у каждого своя отдельная команда и "микрофлора", 18 микросервисов (на каждого свои разработчики и тестировщики))
и за голову хватаешься, до 3х ночи сидишь
но "переучить" заранее к тебе приходить - не получается
да и когда оно бажит, не работает сложно описывать, ТЗ ведь нет - только сам тестируешь, если что вопросы задаешь и пишешь

я так поняла в ИТ не бывает линейного процесса, только такие американские горки)
источник

MS

Maria Shabanova in technicalwriters
Линейные скучно) Я 5 компаний сменила, везде горки
источник

AD

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

CV

Cro Vin in technicalwriters
Alyona Devon
ну перерабатывание такое жесткое тоже не вариант) понимаю еще +час-два, но не вот так же)
хотя может если пару раз не будешь так сидеть и отвечать - нужно было раньше говорить, то будет помешься таких ситуаций
Напишите политику по инициации задач в вашей компании. «На бумаге» закрепите свои идеи по изменениям в процессах. Возможно, потом воплотите это в практическую деятельность
источник

AD

Alyona Devon in technicalwriters
Maria Shabanova
Значит придётся учить программирование) Чтоб никого не дергать))
да я об этом думала - хотя сомневаюсь что дев пустит к себе на кухню что-то "достраивать") есть же риск поломать что он делал)
то есть время проверить или проследить или рассказать что у него где находится все равно придется выделить кому-то

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

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

E

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

AD

Alyona Devon in technicalwriters
ну вот когда на меня сыпался поток задач про новые фичи у меня тоже были идеи
или когда я работала в сапорте и постоянно плевалась на документацию
потом появилось время я это все изменила и внедрила и ступор наступил)

может просто непривычно, когда много лет под большим прессингом работаешь вдруг он отступает.. и тебе непривычно)
нужно радоваться и дальше работать над улучшением

а чем кстати вдохновляетесь, как что улучшить, какими примерами?
источник

AD

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

E

Evgeniia in technicalwriters
Я вдохновляюсь другими сайтами с документацией, как у них сделана навигация, где поиск находится, как они строят архитектуру, как пишут, какие схемы рисуют. Часто сама понимала, что у нас есть проблемы и их надо решить. Иногда коллеги приходили с вопросами, и из них можно было понять, что есть проблемы.
источник

SL

Stan Lo in technicalwriters
@edarkling я раньше (лет пять назад) тоже сильно волновался в периоды затишья, начинались всякие угрызения совести, мол, сижу толком ничего не делаю. Но потом наблюдения показали, что ничего придумывать не нужно, реальность сама подкинет работы. А чтоб спокойнее ждалось, есть куча записей с конференции, статей, книг и курсов по специальности и около.
источник

E

Evgeniia in technicalwriters
Затишья перед бурей я всегда боялась, т.к. за ним естественно следовала буря )) С начала я переживала, как так, не успеваю ничего. А потом решила взять все в свои руки. Когда наступало время затишья, приходила к менеджерам и спрашивала, чего они уже наколбасили, давай опишем, а то потом времени не будет. Обычно что-то уже подкидывали.
В итоге я все равно опаздывала, но делала это более расслаблено ))
источник

AD

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

AD

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

AD

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

E

Evgeniia in technicalwriters
Alyona Devon
а если вы себе где-то сохраняли, можете пожалуйста сбросить такие примеры)
Я в закладки сохраняла доки: stripe, atlassian, Storybook, tilda, slack, Figma, Weather API,
Но это еще не значит, что наша дока стала лучше )) Я все только планировала да мечтала, руки не дошли
источник

E

Evgeniia in technicalwriters
Еще я делала опрос на сайте документации, чтобы узнать, что за аудитория вообще ее читает, и с какими проблемами они сталкиваются. Народ много интересного написал. Все это почитать и графики посмотреть тоже время занимало )
источник

AD

Alyona Devon in technicalwriters
Evgeniia
Я в закладки сохраняла доки: stripe, atlassian, Storybook, tilda, slack, Figma, Weather API,
Но это еще не значит, что наша дока стала лучше )) Я все только планировала да мечтала, руки не дошли
а есть способ узнать что эти документации используют, оно само генерится с помощью сервиса для дкоументаций или это самописный стиль
ну вот такое все к примеру https://monosnap.com/file/uQi8IktBvJSTljpt8sFNSZLEGCL9GI
https://slack.com/intl/en-ua/help/articles/225531168-Change-a-members-email-address

я п примеру знаю что такое наши верстальщики могут сделать - потом мне говорят только класс и я его добавляю к тексту
инлайново в html css не разрешают рисовать добавлять
источник