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

тут да. когти рвать надо

Мне нравится второй подход и всегда стараюсь придерживаться именно его. Так даже документ получается лаконичнее. Но в последнее время столкнулась с тем, что пользователь полез в меню с настройками, решил найти в документации подробнее про конкретную настройку и не может найти, т.к. раздел с его описанием назван не "в лоб"  (в его представлении он должен содержать название меню, вкладки). Искать через поиск - его не устраивает.
В итоге получаем некое дублирование контента и все равно документ со временем критично увеличивается в объеме

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

- Это что, рутовский доступ?
- Да
- красивА

XD

Есть базовые роли, но набор прав настраиваемый. User-ы у одного клиента запросто могут быть наделены доступом в некоторые разделы с настройками, а у другого - только на чтение

Вдобавок владельцы софта могут создавать свои роли и наделять их правами по своему усмотрению.
Мы пишем документацию изходя из базовых настроек доступа, т.к. невозможно учесть все возможные конфигурации софта. Часть мануала представляет собой description и далее уже дополняем кейсами. В виде онлайн-справки все не так страшно. В формате pdf - около 600 страниц только на 1 софт 🙈

сочувствую и понимаю

Мануал на линейку свичей Huawei занимает скромные 1300+ страниц в pdf, да и вполне программные Veeam Backup в своем User guide перешагнул отметку 1500.

Мануал для Боинга 2700 и выше)

Интересно, сколько человек пишут мануалы для Huawei 🤔

Вот у Ан-148-100 всё четко в инструкциях по нештатным ситуациям: НАЖМИТЕ, ДОЛОЖИТЕ, УДЕРЖИВАЙТЕ

Панику... НЕ УСТРАИВАЙТЕ

))

Спасибо.

Здесь оценят ))

В-2ем :)

#вакансия #техническийписатель #удаленно #wanted_tw

Вакансия: Senior Technical Writer
Компания: Arenadata https://www.youtube.com/watch?v=RKZ7Chty98Y&t=38s
Локация: 100% удаленно (или можно работать в офисе в Москве)
Заработная плата: до 200 тыс. руб. на руки (для уровня Senior)

Что сейчас есть:
- документация на русском языке
- все сборки документации в формате rST и собираются sphinx-doc

Что надо делать:
- собирать информацию у архитекторов, аналитиков и разработчиков
- самостоятельно изучать наши продукты и проходить все описываемые действия на тестовых стендах
- разрабатывать и актуализировать документацию на английском языке
- применять подход Docs as a Code

Кого мы ищем:
- 5+ лет опыта работы техническим писателем
- большой опыт написание различной технической документации на современные IT-продукты (БД, продукты с микросервисной архитектурой, бэкенд, фронтэнд и тд)
- опыт написания документации для разных категорий пользователей
- знание GitHub, опыт с движками генерации статических сайтов и с различными легковесными языками разметки
- опыт работы в консоли, знание Linux на уровне опытного пользователя
- знание английского языка на хорошем уровне для написания документации (Upper Intermediate минимум)

Плюсом будет:
- опыт написания документации на распределённые системы (например, БД, блокчейн)
- опыт программирования на Java/C++
- опыт работы с Antora и Asciidoc
- знание инструментария CI/CD, Docker для задач технической документации

Условия:
Официальное оформление по ТК РФ, белая ЗП;
Cертификация и обучение за счет компании;
Возможность работы удаленно и гибкий график;
Обеспечение техникой для работы (ноутбук, монитор);
Корпоративные курсы английского;
ДМС со стоматологией.

✉️ Контакты: @pankina_hr poe@arenadata.io

Добрый день коллеги.Подскажите пожалуйста что отностится к созданному(приобретенному ) имуществу по ОКР?