Комментарии 33
Про скриншоты — можно еще посоветовать обрезать лишнее и заблюривать неважное. Иначе среди пестрых стотыщмильонов кнопочек и ползунков, нерелевантных в данном случае, внимание читателя заблудится и потеряется.
Правда, конечно, делать надо осторожно. Иногда бывает другая крайность — на скриншоте просто кнопка, которую надо нажать. А где именно на экране эта кнопка находится — пока с лупой каждый пиксель не просмотришь — не поймешь (особенно если речь о профессиональном софте, интерфейс которого похож на панель управления Боинга и одним взглядом с непривычки его не охватишь).
Спасибо за комментарий!
«должно быть понятно какой компании он принадлежит»
«видите насколько по-разному выглядят»
«чтобы понять о чем он», «понять на чем остановить свой взгляд» — вот тут уже повторяющаяся ошибка;
«Когда пишу я, понимаю, что есть новые пользователи» — вероятно, просто описка;
«важно понимать о каких окнах, разделах, полях», «Важно понимать как они выглядят» — нет, всё же автор прогуливал лекции по пунктуации ;)
«наша цель всё-таки не озадачить», «а главное востребованной» — пропущены тире;
«Вы пишите серьезный документ» — вероятно, описка.
Вообще-то запятые и тире пропущены ещё кое-где, но просьба не судить строго — я всё же не писатель, а всего лишь комментатор )))
Проблема контрастного дизайна отпала с введением markdown/asciidoc. проблема со скриншотами, конечно, посуровей.
Ещё пару предложений из моего опыта (напишу тезисно):
- Проверять DPI скринов. Все скриншоты должны быть сняты с мониторов одним и тем же DPI.
- Подписи к картинкам (alt) — это крайне важная штука для понимания.
- Ссылки внутри документации. По умолчанию следует добавить/сгенерировать на каждый заголовок уровней H1-H2.
- Термины и определения. Если подобное требуется, либо выносим в отдельный раздел + добавлять ссылку на каждое использование термина. Либо выделите первое/каждое вхождение в статье термина — и пусть по нажатию/наведению появляется всплывающее окно с текстом определения.
Ну и стараемся корректно писать символы: тире, дефис; не забываем про апострофы и кавычки.
Также много интересных фишек можно подсмотреть в руководстве по написанию документации на docs.microsoft.com (https://docs.microsoft.com/ru-ru/contribute/markdown-reference)
Эта статья моя. Я транслировала своё мнение об этих темах.
Спасибо за мнение…
Я только ЗА, если вы напишите ещё статью на эту тему. И сделаете это по-своему.
Одновременно много действийНаверное это не хорошо. Но что является альтернативой скриншота с 4 пронумерованными стрелочками? 4 разных скриншота. Я просто буквально недавно читал подобный документ, листать его утомительно глазами выискивая следующий текст и картинку, еще и текст с картинками меняют свое положение по вертикали при пролистывании (Alt+Tab, PgDown, «где я был до этого?»).
А еще плохо когда не понятно какой текст относится к картинке — тот что вверху или тот что внизу.
Много скриншотов — это не так плохо, как их отсутствие.
И кому-то обязательно не понравится такое, а кому-то наоборот.
Моя статья = Моё мнение.
А про второе: сначала текст, потом картинка.
По тезису "1 скриншот == 1 атомарное действие" не согласен.
Предпочитаю размещать несколько, с нумерацией и подчеркиванием последовательности действий стрелочками. Но естественно — до 5 шт, хотя обычно выходит 2-4.
Обоснования:
- много скриншотов затрудняет чтение — нужно переходить от текста с описанием на скриншот и обратно;
- на одном листе А4 печатного документа вы можете разместить максимум 2 рисунка, в онлайн справке положение не лучше;
- затраты на поддержку актуальности в случае изменения интерфейсов существенно больше.
Я так не говорила. У меня их может быть максимум 3 на одном скриншоте.
Если скриншоты затрудняют чтение, то это не те скриншоты. Я считаю, что они как дополнение (прочитал -> посмотрел на скриншот -> сделал в системе).
Про размещение 2-х скриншотов на А4 тоже неверно. Если я один раз показала в разделе окно целиком, то дальше я буду показывать фрагменты этого окна, а они не занимают много места.
Затраты на скриншоты немаленькие. Если компания не может себе этого позволить, она не делает их => Ей незачем эта статья вообще.
За много лет прошёл разные варианты создания инструкций, но самые простые имели в себе один-два скриншота, а что за чем нажимать было обозначено стрелочками с цифрами. Даже самая отчаянная домохозяйка с настройкой софта справлялась. В основном потому, что глядя на скриншот с обозвачениями действий не надо было думать куда дальше нажимать и что ещё искать на картинке.
Внешний вид и скриншоты в пользовательской документации. Как надо и не надо делать