Редакционная политика¶
Правила, по которым написана эта документация. Нужны, чтобы новые страницы не дрейфовали по стилю, а правки не спорили с уже принятыми решениями.
Тон и регистр¶
- Обращение — на «ты», последовательно во всех разделах. Документация — полевое руководство, а не корпоративный регламент.
- Правила и инструкции — императивами: «опирайся», «проверь», «добудь». Без «рекомендуется осуществлять».
- Без канцелярита и «воды»: короткие предложения, конкретика вместо общих слов.
- Метафоры методологии (призма, спираль, светофор, двери) — рабочий словарь, используем их вместо синонимов.
Три яруса подачи¶
Каждый концепт методологии объясняется на трёх уровнях глубины — и только на них:
| Ярус | Где живёт | Формат |
|---|---|---|
| Короткий (~2 мин) | Главная | Питч: проблема, суть, когда полезно. Без таблиц-справочников |
| Средний (~30 мин) | Призма за 30 минут | Сжатые таблицы всех концептов + упражнения + FAQ |
| Полный (справочник) | Методология | Канонические определения, детали, краевые случаи |
Шпаргалка — не ярус, а рабочий инструмент: выжимка, которую держат перед глазами во время исследования.
Правила поддержки структуры:
- Новое объяснение концепта добавляется только в канон (страницы методологии); на других ярусах — сжатая версия со ссылкой на канон.
- Каждая страница раздела «Методология» начинается блоком
!!! abstract "Коротко": 2–4 строки прозы (без таблиц!) — о чём страница и когда её читать. - Ссылки «для новичка» ведут на простейшие материалы: quickstart, экспресс-пример.
Терминология¶
Критерий для англицизмов. Английский термин остаётся без перевода, только если он (а) устоялся в русскоязычной профессиональной среде и (б) точнее любого перевода. Во всех остальных случаях — русский термин; в спорных — русский с оригиналом в скобках один раз, при первом употреблении в каноне.
Закреплённые термины (остаются как есть, глоссированы в подсказках): pre-mortem, due diligence, KPI, бенчмарк, чеклист, постмортем.
Закреплённые переводы: критерии выхода (не exit criteria), рабочий процесс (не workflow), типовые задачи / сценарии использования (не use cases), типовые отказы (не failure modes), приживаемость (не adoption), меры снижения риска (не mitigation), лимит времени (не таймбокс), нехватка времени (не цейтнот), стартовый словарь (не бутстрап), исследование (не ресёрч).
Бренд-термин: «свидетельства-first» — фирменное название правила №1, пишется именно так (кириллица + first), с глоссой «сначала свидетельства» в подсказках. Не переводить и не менять написание.
Новый термин методологии → добавь глоссу в docs/includes/abbreviations.md — подсказки подключаются на всех страницах автоматически.
Орфография и типографика¶
- Ё — везде, последовательно: даёт, ещё, надёжно, объём.
- Пара pre-mortem / постмортем пишется именно так: pre-mortem — латиницей с дефисом (метод), постмортем — кириллицей слитно (жанр отчёта об инциденте).
- Кавычки — «ёлочки»; вложенные — „лапки“.
- Тире — длинное (—) с пробелами; диапазоны — короткое без пробелов (2–4 часа, S1–S7); между фамилиями — тире (эффект Даннинга — Крюгера).
- Светофор
и оценки
++/+/±/−— семантические элементы методологии, не декор: используются только в закреплённых значениях (уверенность и оценка соответственно).
Проверка перед публикацией¶
- Страница вписана в свой ярус: не дублирует канон, а ссылается на него
- Глубокая страница начинается с
!!! abstract "Коротко" - Обращение на «ты», правила — императивами
- Новые термины — по критерию англицизмов, глоссы добавлены
- Ё, кавычки, тире — по правилам выше
-
mkdocs build --strictпроходит без предупреждений о ссылках