ME
многое - вкусовщина. когда я прихожу в компанию, где отродясь только девелоперы и саппорт писали доки, я не кидаюсь с шашкой наголо учить их родину любить. usable - уже хорошо
Size: a a a
2021 June 25
AC
Я не про критику - а про советы писателям по их запросу.
МК
на ютубе мне попалась как-то видюха с положительными примерами формулировок раздела "Цели и назначение Системы"
знаете, что там за пример был...примерно такой: "Система предназначена для формирования в Модуле1 такой-то информации и переносу этой информации в Модуль2 для такой-то функции"
- ...??? wtf
знаете, что там за пример был...примерно такой: "Система предназначена для формирования в Модуле1 такой-то информации и переносу этой информации в Модуль2 для такой-то функции"
- ...??? wtf
ME
мне больше нравится формат writing day, когда проект приходит к писателям и говорит мол смотрите, мы не знаем как организовать наши доки, как объяснить. нам нужна помощь
AC
А как попасть в такой проект, где я бы смог, совершенно за бесплатно, помогать другим писателям? Я это могу и мне несложно.
ME
я тут уже писала на эту тему) на Write the docs часто приходит опенсорс (даже энтерпрайзный, типа trinoDB) в поисках контрибуторов, но им нужно более-менее долгосрочное сотрудничество, чтобы не вводить каждого нового человека в курс дел. я бы начала с предложения помощив слак спейсе Write the docs
ME
Scylla ещё запомнилась с последней конференции
ME
writethedocs.slack.com, канал #community-help-wanted
AS
Я представитель такого проекта, кто готов?))
ME
класс, покажите проект)
AS
ME
а в чем нужна помощь? текст на лендинге и в фичах написан шероховато, тут бы нейтив копирайтера
AS
Как раз в организации документации для юзеров в формате инструкций и скринкастов. Вот тут пока изучаю как лучше и понятнее делать :)
ME
хороший писатель бесстыдно ворует) смотрите как такие штуки организованы у конкурентов
AS
Спасибо) а как вы отслеживаете актуальность доки? Мы часто вносим изменения и порой даже не успеваем опубликовать, как протухла)
AS
И есть ли опыт, как лучше воспринимают текст/видео?
ME
я вижу идеальный мир так: кто-то в этом чате, кто ищет первый опыт или работу для портфолио, напишет для вас доку, а мы всем миром её поревьюваем :D
ME
каждое изменение в коде = проверка актуальности доки. в разных компаниях флоу устроен по-разному, и соответственно эта проверка на разных людях, где-то на кодерах, где-то на писателях
ME
видео очень "дорогой" формат, его долго и затратно делать и изменять, если без видео не обойтись, лучше снимать его тогда, когда интерфейс уже устаканился
ME
в нашем центре поддержки видео/гифки всегда дублируются текстом. видео короткие, до 30 секунд. для огромной фичи проще провести вебинар и выложить запись