Обновить
0
0
Мария Бурханова@mrbrhnv

Руководитель IT-направления (документация)

Отправить сообщение

Да, и не только будет обогащаться, но и точно будет меняться. Например, мы оставили как основной термин «выпадающий список» (англ. dropdown). Зафиксировали нерекомендуемые: «выпадашка, дропдаун, dropdown». После ревью глоссария дизайнерами платформы мы изменили «выпадающий» на «раскрывающийся», потому что, как нам вполне логично объяснили коллеги, «раскрывающийся список», а не «выпадающий», потому что его главная задача — не «выпадать», а «раскрываться». Кроме того, у него есть обратное действие — «скрываться», а не «впадать» :)

Такие изменения и новые термины мы фиксируем через задачи в трекере. Любой желающий может завести в наш бэклог задачу по шаблону для нового термина или оставить аргументированное предложение для изменения существующего термина.

Эта была самая трудоёмкая часть работы. В принципе, можно про это написать отдельную статью :) Если коротко, то мы руками схлопнули все повторяющиеся в нашей документации формы одного слова (например, чекбокс / чек-бокс / чек бокс). Потом к каждому термину из этого списка мы подобрали все возможные варианты употребления этого термина в нашей документации (добавили, например, флажок / отметка). Далее посчитали количество упоминаний каждого варианта. Этими шагами ответили для себя на вопрос, вызывает ли это понятие сложность при выборе написания – да, вызывает. Содержит ли ошибки? Да, содержит, потому что правильное написание "чекбокс" https://gramota.ru/meta/chekboks . Требует ли определений? Да, требует, потому что наряду с чекбоксом есть ещё отметка и флажок. И нам нужно определить, в каких случаях нужно использовать то или иное слово.
Пример:

Ох, прям курс, наверное, я порекомендовать не могу. Мне лично помогли разного рода статейки про UML и про проектирование системы в целом. Но, возможно, у кого-то из коллег есть хорошие рекомендации курса. Самой было бы интересно :)

Это да :) Но иногда их нет. Иногда техническому писателю нужно совмещать в себе и роль аналитика. А так - да, сто процентов

Большое спасибо, я очень рада, что нашли полезное :) Полностью согласна про большие схемы

Да, есть такой момент. Согласна

Информация

В рейтинге
Не участвует
Откуда
Москва, Москва и Московская обл., Россия
Работает в
Зарегистрирована
Активность

Специализация

Технический писатель
Старший
Управление проектами
Построение команды
Разработка ТЗ
Планирование
Agile