Size: a a a

Технические писатели

2021 September 18

ND

NASTYA Dm in Технические писатели
Я первым делом советую этот тг-канал
источник

О

Ольга in Технические писатели
А я про него спрашиваю на собеседовании )) Приятно, когда кандидат знает про этот канал
источник

ND

NASTYA Dm in Технические писатели
Согласна
источник
2021 September 19

1

1 in Технические писатели
Быстрый заказ (работа).  #wanted_tw

Ищу человека знающего oxygen xml + dita.

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

Пишите мне в личку, док отправлю. Оплата сразу.
источник

AB

Albina Brycheva in Технические писатели
Коллеги, продолжаю поиски нового инструмента для написания мануалов. Углубилась в изучение идеи Docs as code и возник вопрос, насколько нам такой подход поможет, если код разработчиками вообще не документируется? Говорят, такой необходимости нет сейчас.
Всю информацию они передают устно техписателю.
источник

ME

Maria Ermakovich in Технические писатели
и даже комментарии в коде не пишут?
источник

ME

Maria Ermakovich in Технические писатели
а как онбордятся новые погромисты?
источник

ME

Maria Ermakovich in Технические писатели
неожиданный бонус того, что документация лежит рядом с кодом - разработчики ОЧЕНЬ внимательно читают то, что кладёт в их репу техписатель) всегда куча комментариев
источник

ME

Maria Ermakovich in Технические писатели
в результате иногда можно выяснить, что случился испорченный телефон
источник

AB

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

ME

Maria Ermakovich in Технические писатели
да, не общаться не получится)
источник

AB

Albina Brycheva in Технические писатели
это безусловно плюс! да!
источник

ME

Maria Ermakovich in Технические писатели
я иногда пишу "рыбу" из подзаголовков, прошу девелопера написать своими словами в каждый раздел, потом правлю сверху
источник

ME

Maria Ermakovich in Технические писатели
если затягивают, задаю наводящие вопросы в чятике
источник

AB

Albina Brycheva in Технические писатели
устно 🙈 + комментарии в коде. А вообще каждый новый человек к компании проходит некий этап изучения того, чем вообще компания занимается. А там уже погружается код, параллельно работая в течение некоторого времени со старшим разработчиком
источник

ME

Maria Ermakovich in Технические писатели
если новичков не много, может и норм
источник

AB

Albina Brycheva in Технические писатели
у вас разработчики тоже заинтересованы в наличии документации к коду, как и техрайтер? У нас два процесса идут независимо, увы. Хочу обосновать им необходимость подхода  Документации как код, а не представить так, как будто им нужно будет дополнительную работу проделывать.
источник

AB

Albina Brycheva in Технические писатели
немного, поэтому и не заморачиваются. За последний год 2 разработчика, до этого несколько лет не менялся состав
источник

ME

Maria Ermakovich in Технические писатели
это не вы им должны обосновать, а их начальник) иначе это будет борьба с ветряными мельницами
источник

AB

Albina Brycheva in Технические писатели
Я прослушала вебинары от Ducumentat, вдохновилась! Писать как раньше уже не хочу!
источник