Перейти к содержанию

«Что нового» и несколько платформ

Журнал релизов в документации один на продукт (не дублируем меню по macOS / Windows / Android / iOS). Версии на разных ОС могут выходить в разное время, поэтому важно явно указывать, к какой платформе относится каждое изменение.

Сводная таблица на странице «Что нового»

В таблице опубликованных версий добавляйте колонку «Платформы»:

Значение Когда использовать
все Одинаковый смысл для всех клиентов (общий протокол, формат данных, серверная часть без привязки к ОС).
macOS, Windows, Android, iOS Одна или несколько перечисленных через запятую, если релиз или пункт только для них.
см. страницу В таблице неудобно перечислить (например, разные номера сборок по ОС) — детали только в тексте страницы версии.

Если для одной записи в таблице (одна страница версии) сборки разливаются по датам, в колонке можно кратко: macOS 1.2 · Windows 1.1 или оставить см. страницу.

Шапка страницы версии

Сразу под заголовком # Версия … полезно вынести блок охвата (таблица или список):

| Платформа | Версия / сборка | Дата |
|-----------|-----------------|------|
| macOS | 1.2.0 | 2026-04-01 |
| Windows | 1.1.0 | 2026-03-15 |

Если релиз только для одной ОС — одна строка или одна фраза: Только Windows.

Пункты в списках изменений

У каждого пункта в Добавлено / Изменено / Исправлено в начале строки указывайте метку платформы:

  • [все] — для всех клиентов.
  • [macOS], [Windows], [Android], [iOS] — только для перечисленных; несколько: [macOS, Windows].

Пример:

### Исправлено
- [Windows] Контекстное меню для ZIP не появлялось после обновления.
- [все] Синхронизация: исправлена ошибка при пустом поле комментария.

Когда делить страницу на подзаголовки по ОС

Имеет смысл, если для одной даты тексты сильно разные и список превращается в «кашу» из меток:

## macOS
### Добавлено
- 
## Windows
### Добавлено
- 

В меню по-прежнему одна страница на версию (или на логический релиз).

Кратко

  1. Одна ветка «Что нового» на продукт.
  2. Колонка «Платформы» в сводной таблице + при необходимости таблица в шапке страницы версии.
  3. Метки [macOS] / [все] у пунктов списка — обязательный минимум, если платформы расходятся.

← Общие принципы · На главную документации