basforge

Ищем по названиям, тексту и разборам «Если не работает».

    EN

    Дробление текста: где резать и сколько класть в один кусок

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

    Сколько в одном куске

    Кусок Сколько Почему
    Предложение одна мысль, до 20–25 слов на втором придаточном теряется подлежащее; два факта — две фразы
    Абзац одна мысль, 2–5 предложений, 3–5 строк на компьютере на телефоне строки вдвое короче, и 5 строк становятся 10–11
    Пункт списка строка или две маркер обещает короткое; длиннее — это абзац
    Список 3–7 пунктов больше — пункты сливаются; делим на группы с подзаголовками
    Шаг мануала одно действие и что должно получиться два действия в шаге — второе пропускают
    Раздел один вопрос читателя, 1–3 экрана длиннее — внутри уже два вопроса, нужен h3
    Таблица 2–5 колонок на 360 px в строку помещаются 2–3 колонки, остальное уезжает в прокрутку
    Экран один смысл то, что видно без прокрутки, отвечает на один вопрос («Один экран — один смысл»)

    Числа здесь — ориентиры. «7 ± 2» Джорджа Миллера (1956) — объём кратковременной памяти, и к спискам на экране его прикладывают зря: список не запоминают, он перед глазами. Предел у списка другой — пока пункты отличаются друг от друга на взгляд.

    Где резать: признаки в тексте

    Видим в тексте Режем так
    «также», «кроме того», «ещё» в середине абзаца новая мысль — новый абзац
    три и больше пунктов через запятую маркированный список
    «сначала… потом… после этого» нумерованный список шагов
    две-три вещи сравниваются по признакам таблица: вещи в строках, признаки в колонках
    «если…, то…» больше двух раз таблица «Если… — Делаем»
    тема абзаца меняется на полпути подзаголовок перед новой темой
    команда, путь или кусок конфига внутри фразы блок кода отдельной строкой
    «важно», «обратите внимание» одно предупреждение на материал, остальное — обычным текстом

    Где не режем

    Случай Почему
    рассуждение с «потому что», «поэтому», «зато» связки — и есть содержание; в пунктах они пропадают
    причина рядом со следствием «ufw не закрывает порт контейнера» без «потому что пакет идёт в forward» — непонятное правило
    предупреждение рядом с шагом, к которому оно относится вынесенное в конец предупреждение читают после того, как сломали
    список из одного пункта это фраза, маркер лишний
    оговорка и граница: версия, «на ARM не проверено» при дроблении её срезают первой, а без неё тексту нельзя верить

    Если не работает

    Список из 15 пунктов пролистывают, не читая

    Причина
    Однородный длинный список не за что ухватить: пункты сливаются, отличие одного от другого не видно.
    Делаем
    Группируем по 3–7 под подзаголовками или переводим в таблицу с колонкой-признаком.

    Пункты списка — по три предложения, и это тяжелее абзацев

    Причина
    Список взяли ради вида, а внутри — рассуждения: маркер обещает короткую строку, а её нет.
    Делаем
    Рассуждение — абзацами, а в список — только перечисление.

    На телефоне абзац на весь экран

    Причина
    Абзац на 6 строк при ширине 714 px — это около 13 строк на 360 px: строка вмещает 35 знаков вместо 76.
    Делаем
    Абзац — одна мысль и до 3–5 строк на компьютере; длиннее — ищем, где вторая мысль.