wiki:typography_standard
Это старая версия документа!
Содержание
Типографический стандарт DokuWiki
Статус: Действующий протокол
Назначение: Обеспечить читаемость, навигацию по смысловым уровням и предсказуемость чтения от страницы к странице.
Принцип: Типографика корпуса — это система визуальной организации текста, которая обеспечивает читаемость, навигацию по смысловым уровням и предсказуемость чтения от страницы к странице.
1. Базовые требования
- Читаемость важнее декоративности.
- Один визуальный сигнал должен выполнять одну устойчивую функцию.
- Акценты используются экономно.
- Структура страницы должна считываться с первого просмотра.
- Любое решение должно оставаться читаемым с мобильных устройств.
- Если оформление мешает чтению, оно считается ошибкой оформления.
2. Заголовки
- На странице допускается только один заголовок первого уровня:
`====== Название страницы ======`
- Заголовки второго уровня используются для основных смысловых блоков:
`===== Раздел =====`
- Заголовки третьего уровня используются для подразделов внутри блока:
`==== Подраздел ====`
- Не следует создавать лишнюю глубину заголовков без необходимости.
- Заголовок должен быть коротким и ясно обозначать содержимое блока.
3. Абзацы
- Основной способ подачи текста — обычные абзацы.
- Абзац должен выражать одну мысль или один шаг рассуждения.
- Слишком длинные абзацы затрудняют чтение; слишком короткие создают рваный ритм.
- Не допускается искусственное разбиение прозы на короткие строки.
- Новый абзац ставится при смене тезиса, функции текста или логического шага.
4. Списки
- Списки используются только там, где действительно есть перечисление, набор признаков, этапов или условий.
- Если мысль лучше читается как связный абзац, она оформляется абзацем, а не списком.
- Пункты списка должны быть синтаксически однотипны.
- Не следует превращать страницу в сплошную последовательность списков.
5. Выделения
Жирный
- `…` используется для терминов при первом введении и для редких ключевых акцентов.
- Жирный не используется как универсальный способ «усилить важность».
- Если в абзаце несколько жирных фрагментов, это признак перегрузки.
Курсив
- `…` используется для авторской ремарки, уточнения, сомнения или мета-комментария.
- Курсив не должен смешиваться с основным тезисом без необходимости.
- Если текст не требует отделения голоса автора, курсив не нужен.
Моноширинный
- `
…` используется для имён файлов, тегов, путей, команд, slug и технических обозначений. - Моноширинный не используется для смыслового акцента.
- Длинные моноширинные фрагменты следует по возможности сокращать или выносить отдельно.
6. Формулы
- Формулы используются только там, где запись действительно проясняет структуру.
- Короткие обозначения внутри текста оформляются как инлайновые:
`$W$`, `$L$`, `$R$`, `$X$`
- Центральные зависимости выносятся в отдельную строку:
`$$ R = f(X, W, L, S) $$`
- Не следует перегружать страницу формулами, если ту же мысль проще передать обычным текстом.
7. Таблицы
- Таблицы используются как инструмент быстрой ориентации, а не как декоративный элемент.
- В таблицу выносится только то, что действительно выигрывает от сопоставления по столбцам.
- Заголовки таблицы должны быть короткими и однозначными.
- Пустые ячейки заполняются прочерком `—`.
- Слишком широкие таблицы считаются плохим решением, особенно если они ломают чтение с телефона.
8. Блоки <code>
- Блок `<code>` используется только для того, что действительно должно читаться моноширинно: фрагменты синтаксиса, короткие схемы, формальные записи, команды.
- Блок `<code>` не используется как способ «просто красиво выделить текст».
- Длинные строки внутри `<code>`, выходящие за пределы мобильного экрана, считаются дефектом оформления.
- Если запись можно безопасно сократить, разбить или перенести в обычный текст без потери смысла, так и следует делать.
9. Горизонтальная линия
- `—-` используется для отделения основного текста от примечаний, рефлексии, приложений или заключительного служебного блока.
- Не следует использовать горизонтальные линии слишком часто.
10. Анти-паттерны
Следующие решения считаются ошибками типографики:
- чрезмерное количество выделений в одном абзаце;
- смешение функций жирного, курсива и моноширинного;
- искусственно рваная проза;
- избыточные списки там, где нужен обычный текст;
- широкие таблицы без необходимости;
- длинные строки в `<code>`, ломающие мобильное чтение;
- формулы ради впечатления, а не ради ясности;
- визуальный шум, при котором акценты перестают работать;
- не использовать начальные пробелы для визуального оформления схем, если не нужен предформатированный блок.
11. Финальная формула
Типографика корпуса должна делать три вещи:
- облегчать чтение;
- показывать структуру текста;
- обеспечивать предсказуемость чтения на всех страницах, включая мобильные устройства.
Если решение не помогает одной из этих функций, оно не нужно.
wiki/typography_standard.1773074373.txt.gz · Последнее изменение: — hottabitch39
