Правила стиля (общие, проверяемые)

Фирменный стиль в одном месте. Пункты с пометкой «(test)» проверяет tests/validate.py; нарушение приводит к сбою сборки. Полная повествовательная версия это spec/conventions.md в корне репозитория.

Жёсткие правила

  • Никаких длинных тире. Никогда не используйте «—» (U+2014). Используйте запятую, двоеточие, скобки или два предложения. Среднее тире «–» допускается только в числовых диапазонах вроде 1–9 или 2.1–2.8. (test)
  • Никаких штампов. Не используйте «not only … but also», «but also» или «load-bearing». Избегайте «It’s important to note», «In today’s fast-paced world», «It’s crucial to consider», «It appears that», «One could argue» и формулы «it’s not just X, it’s Y». (test, для первых трёх)
  • Определяйте термины при первом употреблении. Расшифровывайте аббревиатуры и определяйте жаргон при первом использовании в каждой теме, например «mean time to recovery (MTTR)».
  • Связывайте ключевые понятия с Википедией при первом упоминании, один раз на тему, только в прозе. Форма: [term](https://en.wikipedia.org/wiki/Article_Title). Никогда в заголовках, таблицах, коде или разделе источников. (форма ссылки проверяется тестом)
  • Только настоящие источники. Авторы и названия реальных работ. Никаких выдуманных названий, авторов или URL.
  • Называйте путь манипулирования. Темы семейств метрик говорят, как метрикой манипулируют и какая страховочная метрика это ловит (тема 1.2).

Голос

  • Тёплый, прямой, ободряющий. Обращайтесь к читателю прямо. Короткие предложения, простые слова. Начинайте с сути.
  • Определённый и практичный. Нейтральный по отношению к поставщикам. Упоминайте продукты только как фактические примеры.

Структура (test)

  • Содержательные темы используют в точности порядок разделов из chapter-template.md.
  • Первый заголовок # N.M Title (номер темы с точкой) и совпадает с префиксом PP-CC файла с ведущими нулями.
  • Нумерация внутри каждой части сплошная и начинается с N.0.

После редактирования

  • Если вы изменили набор тем, обновите spec/structure.md и запустите just nav.
  • Всегда запускайте just test.