Просто, но твёрдо хорошо для UI

Чеклист в контент-гайде
#редполитика

Главная проблема контент-гайда в том, как его реально будут использовать. Глупо ждать, что кто-то прочитает от корки до корки и запомнит. Скорее это будет «быстро пробежаться глазами, чтобы исправить грубые ошибки». Поэтому мы решили добавить туда небольшие чеклисты.

Чеклист — это как памятка, по которой пилот проходится перед полётом. Окна — закрыты. Радио — настроено. Знак «пристегните ремни» — включен. Просто и быстро.

Вот этот чеклист поставим в самом начале. Ничего неожиданного или нового, но ближе к реальному использованию. Ну и планируем, что список будет работать как завлекалочка — на каждый пункт повесим ссылки, где в контент-гайде почитать о том или ином пункте подробнее.

— Главное вынесено раньше второстепенного.
— Нет действий без действующего лица («выполняется», «оформлен»).
— Используется простой синтаксис.
— Если текста много, используются абзацы с пустой строкой между ними.
— Нет канцеляризмов, сокращений и непонятных аббревиатур.
— Нет рекламных усилителей («самый», «лучший», «всего лишь»).
— Используются правильные кавычки и тире («», —).
— Телефоны, даты, цифры и валюты в нашем формате.
— Нет смайликов, капслока, восклицательных знаков и «Вы» с большой буквы.

Список отличный. Из личного опыта — главная проблема решается так. Сначала просто редактируешь все тексты, но не сам переписываешь, а оставляешь комментарии, где пишешь, что не так и на что можно заменить. Это чтобы авторы попривыкли. Потом  проводишь серию воркшопов, где много говоришь, убеждаешь, с кем-то споришь, даешь задания, вместе со всеми делаешь и проверяешь. Потом выкладываешь стайл-гайд и тогда уже угрожаешь 🙂

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

С авторами немного проще. Дизайнерам сложнее угрожать)

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

> знает кто такой Лебедев и Ильяхов
Это теперь достижение?

В маленьких продуктовых командах больше и некому 🙁

а команд много

А вы про веб-дизайнеров, кстати? Поделитесь, пожалуйста, а с чем именно у дизайнеров проблемы? Вроде канцеляритом они страдать не должны же. Краткость тоже — у них обычно в интерфейсах просто нет столько места)

UX/UI. к сожалению, часто страдают всеми возможными болезнями.

— Если текста много, используются абзацы с пустой строкой между ними.
надо же...а отступы перед и после строки уже не модно

в интерфейсах уже не очень. Сливается

Ну и в принципе отбивка вместо красной строки уже скорее норма — и в вебе и в приложениях

М.б. кому-нибудь будет интересна эта статья - написана аж 5 (!) лет назад.. Важность DocOps для бизнеса: https://www.cmswire.com/cms/information-management/the-importance-of-docops-in-the-new-era-of-business-027489.php

И еще в копилку: https://devrel.net/developer-experience/docops-engineering-great-documentation

#wanted_tw Омск, Днепропетровск.
В подразделение внутренней автоматизации компании Luxoft требуется технический писатель со знанием английского языка на уровне upper-intermediate и выше (письменный и устный). По всем вопросам и подробностям пишите в личку.

Мастер-класс  "Делаем красивые и понятные таблицы". Сколько надо корма щенку. Возраст 3 месяца. Вес 4 кг.

От 10кг отнимайте 6кг :)