Парадокс. Чем больше я пишу документацию, тем больше я ненавижу людей которые пишут документацию.

потому что большинство документации пишется для сдачи проектов

Хуже

Потому что по той документации, которая мне попадает в руки – даже проекты сдать нельзя.

Перманентный ЪУЪ

Само собой. Конкуренты ж, туды их в качель 😃

Поддержу. Но только с той точки зрения, если пишут ее люди не в теме

Дока vs Разработка

#wanted_tw, Санкт-Петербург

Всем привет! Мы в Semrush ищем технического писателя для работы над внутренней документацией.

Semrush — продуктовая IT-компания, которая разрабатывает тулкит для интернет-маркетологов. Тулкит состоит из множества инструментов, и чтобы разработчики могли работать максимально эффективно, мы стараемся уделять большое внимание внутренним докам.

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

Подробности, условия и плюшки описаны на HH: https://spb.hh.ru/vacancy/45789950

Радует, что всё больше компаний понимают необходимость в нашей профессии!

#Онбординг

Яндекс.Драйв обучает новой фиче.

Дробится сложная информация, есть красивая картинка для привлечения внимания и игривый заголовок.

Онбординг стиле переписки 🤔

привет, а не подскажите как правильно называется колонка про обязательность/необязательность (required/optional) параметра запроса в апи?

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

Мы пишем так: Обязательный - это заголовок, в ячейках пишем Да или Нет

++

чот не заметил ни красивой кдпв, ни игривого заголовка. А кнопка Круто так вообще за гранью имхо

я как аналитик пишу заголовок "Условие обязательности"
а в ячейках:
1. "Всегда" = обязательное
2. {условие} = обязательное, только при выполнении этого условия, например, статус
3. "Не обязательное" или пустая ячейка - очевидно, что поле не обязательное

Тоже не поняла, если честно. И как-то с трудом воспринимается инфа из такого борда.

с трудом, тк каждый блок разного размера и синее на синем