Шаблон — страница фундамента
Одна страница — одно сквозное правило: масштаб типографики, платформа показа, версии, слой состояния, виброотклик.
Живой образец — Масштаб типографики. Смотреть на него полезнее, чем на каркас.
Каркас
- **Версия:** · **Статус:** · **Дата:**
- **Источник:**
| Версия | Дата | Изменение |
|---|---|---|
---
## Обзор
Абзац: что это и зачем.
| Так | Не так |
|---|---|
| _картинка_ | _картинка_ |
## Ключевые числа
Таблица, если у правила есть порог или ряд значений.
## Когда нужно
Наблюдаемые признаки. Одной фразой — когда не нужно.
## Решающее правило
| Что происходит | Решение |
|---|---|
## Как включается
Механизм: токен, свойство, настройка.
## Границы
Что правило не меняет и чего делать нельзя.
## Состояние
Что есть сейчас. Что предстоит — нумерованным списком.
## Рядом
-
Статус обязателен. Правило может быть принято, но ещё не реализовано ни одним компонентом — это видно сразу, а не выясняется в середине.
Пустых разделов не держим. Нет чисел — нет раздела «Ключевые числа». Правило не включается ничем — нет раздела «Как включается».
Что может заполнять сервис
| Состояние: числа | по контрактам — сколько компонентов правилу следуют |
| Ключевые числа: токены | из выгрузки переменных |
Остальное — решения, а не данные. Генератор их не придумает.
Правила письма
- Одно правило — одно предложение. Три правила в абзаце — три пункта списка.
- Три и больше однотипных пунктов — таблица, а не проза.
- Одно правило живёт в одном месте. Повторить его в «Границах», а потом в «Частых ошибках» — удвоить страницу, не добавив смысла.
- Словарей не пишем. Если термин нужно объяснять, он объясняется там, где впервые встретился, одной фразой в скобках.
- Величина — числом и токеном.
space-05, а не «достаточный отступ». - Правило говорит, что делать или чего не делать. «Следует учитывать» — не правило.
- Предложение, которое только объявляет следующее («Ниже рассмотрим…»), вычёркивается.
- Ни YAML, ни устройства контрактов, ни слов формата. Это подробности реализации.