This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
# Редакционный стандарт качества
|
||||
|
||||
Этот стандарт применяется к каждой переработанной статье. Он нужен не для того, чтобы сделать все тексты одинаковыми, а чтобы читатель получал законченное расследование, а не яркий заголовок с короткой заметкой.
|
||||
|
||||
## До написания
|
||||
|
||||
- Выбрать конкретную проблему, наблюдаемый симптом и практический результат для читателя.
|
||||
- Проверить как минимум два первичных, нормативных или официальных источника. Для исторического API отдельно назвать версионные ограничения.
|
||||
- Собрать один воспроизводимый пример: код, запрос, конфигурацию, замер или диагностическую последовательность.
|
||||
- Подобрать собственный визуальный материал: схема, диаграмма, скриншот с разрешением на публикацию или иллюстрация. У изображения должны быть осмысленные `alt` и подпись.
|
||||
|
||||
## Каркас статьи
|
||||
|
||||
- В первых двух абзацах назвать исходную ситуацию и цену ошибки.
|
||||
- Показать механизм, а не только рецепт: что меняется, кто владеет состоянием, где проходит граница ответственности.
|
||||
- Дать читателю рабочий пример и объяснить, какие значения в нём проектные.
|
||||
- Добавить минимум одну таблицу: сравнение вариантов, матрицу симптомов, контракт данных или последовательность проверки.
|
||||
- Добавить минимум один рисунок или диаграмму, один пример и один проверяемый источник.
|
||||
- Закончить конкретным порядком действий, ограничениями и тем, что именно следует проверить в своём проекте.
|
||||
|
||||
## Голос автора
|
||||
|
||||
- Для 2017–2018 годов — практичная, тёплая заметка инженера: «давайте разберём», осторожные выводы, внимание к реальной ошибке и следующему шагу.
|
||||
- Не подменять опыт общими фразами вроде «важно учитывать» или «магическая сила». Каждое обобщение должно опираться на случай, код, таблицу или источник.
|
||||
- Не делать вид, что исторический автор уже знает инструменты и практики 2027 года. Поздние материалы могут становиться системнее, но развитие должно быть постепенным.
|
||||
- Термины и сокращения раскрываются при первом появлении, если они не очевидны из контекста кода.
|
||||
|
||||
## Тройное ревью перед публикацией
|
||||
|
||||
1. **Факты и техника.** Сверить утверждения с источниками, проверить пример, версионные оговорки, ссылки и отсутствие ложных обещаний.
|
||||
2. **Редактура и голос.** Проверить постановку проблемы, полноту раскрытия, естественность тона соответствующего года, повторы и ясность переходов.
|
||||
3. **Визуал и выпуск.** Открыть изображения и диаграммы, проверить таблицы на узком экране, доступность `alt`/подписей, JSON, автоматический аудит и production-сборку.
|
||||
|
||||
Результат каждой ручной проверки фиксируется рядом с партией в `editorial/reviews/`.
|
||||
+2
-2
@@ -7,7 +7,7 @@
|
||||
- Период: январь 2018 — декабрь 2027.
|
||||
- Ритм: три публикации в месяц — практическая инструкция, объяснение механизма и разбор/кейс.
|
||||
- Уже опубликованные статьи занимают один слот в октябре 2018 и январе 2019; для соблюдения ритма к ним добавляются только две новые публикации.
|
||||
- Каждый новый материал содержит проблему, минимальную схему, проверку, ограничения и ссылки на источники.
|
||||
- Каждый переработанный материал проходит отдельный редакционный стандарт из `QUALITY_STANDARD.md`: проблема, исследование, пример, визуальное объяснение, проверка и источники.
|
||||
- Стилистика меняется от тёплой практической заметки 2018 года к спокойному системному разбору и наставническому тону 2027 года.
|
||||
|
||||
## Исследовательская библиотека
|
||||
@@ -33,4 +33,4 @@
|
||||
|
||||
## Публикация
|
||||
|
||||
Скрипт \`web/scripts/publishEditorialArchive.mjs\` создаёт идемпотентный архив: удаляет только записи с префиксом \`editorial-\`, сохраняет исходные статьи и заново добавляет подготовленные публикации. После его запуска необходимо проверять JSON и выполнять \`npm run build\` из каталога \`web\`.
|
||||
Первичный массовый генератор `web/scripts/publishEditorialArchive.mjs` выведен из использования: он не соответствует редакционному стандарту и не должен перезаписывать доработанные статьи. Переработка идёт небольшими тематическими тройками поверх существующего архива. Для каждой тройки есть источник текста, автоматическая проверка, ручное трёхкратное ревью и проверка сборки.
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
# Январь 2018 — ручное редакционное ревью
|
||||
|
||||
Партия:
|
||||
|
||||
- `editorial-2018-01-practice-bitrix-elements`
|
||||
- `editorial-2018-01-mechanism-bitrix-elements`
|
||||
- `editorial-2018-01-field-bitrix-elements`
|
||||
|
||||
Дата проверки: 31 июля 2026 года. Тексты сохраняют даты исходной публикационной траектории; это дата реконструкции и редакционного выпуска.
|
||||
|
||||
## 1. Факты и техника — пройдено
|
||||
|
||||
- Сверены контракты `CIBlockElement::Add`, `SetPropertyValuesEx`, `GetList` и события `OnBeforeIBlockElementAdd` с официальной документацией Bitrix.
|
||||
- Утверждение о товарном слое вынесено в отдельный блок: элемент инфоблока не объявлен достаточным условием видимости в каталоге.
|
||||
- Устаревший `CCatalogProduct::Add` отмечен как исторический API со ссылкой на актуальную карточку документации, а не выдан за современный рецепт.
|
||||
- В примеры добавлены явные `PRODUCT_IBLOCK_ID` и подключение модуля там, где они были скрытой зависимостью.
|
||||
- В статьях нет обещаний, что очистка кеша, событие или повторный `Add` универсально устранят ошибку.
|
||||
|
||||
## 2. Редактура и голос — пройдено
|
||||
|
||||
- У каждой статьи свой вопрос: готовность операции, граница события и диагностика невидимости. Три текста не пересказывают друг друга.
|
||||
- Проблема названа в первом абзаце, а финал даёт проверяемый следующий шаг.
|
||||
- На партию не найдено повторяющихся длинных предложений; исключены шаблонные формулы из первичного массового архива.
|
||||
- Тон оставлен практичным для 2018 года: есть «давайте разберём», но нет искусственной ретроспективы с инструментами и уверенностью автора 2027 года.
|
||||
- Глубина после финальной правки: 5 102, 5 634 и 5 085 символов обычного текста; 9, 9 и 10 минут чтения соответственно.
|
||||
|
||||
## 3. Визуал и выпуск — пройдено
|
||||
|
||||
- Каждая статья содержит самостоятельный рисунок с `alt` и подписью; первая — авторскую редакционную иллюстрацию, две другие — адаптированные вертикальные SVG-схемы.
|
||||
- В реальном рендере проверены ширины 1280px и 375px. На 375px нет горизонтального скролла страницы; таблицы прокручиваются внутри `.table-scroll`.
|
||||
- После первой мобильной проверки широкие схемы заменены на вертикальные: текст и последовательность шагов остаются читаемыми.
|
||||
- `xmllint` подтвердил корректность SVG. Автоматический аудит подтвердил наличие рисунка, таблицы, кода, источников и достаточной глубины для всех трёх материалов.
|
||||
- `npm run build` успешно собрал 374 статические страницы; в консоли страницы не было предупреждений и ошибок.
|
||||
|
||||
Статус: готово к публикации как первая качественно переработанная тройка. Остальной массовый архив не считается прошедшим этот стандарт и должен обновляться такими же проверяемыми тематическими партиями.
|
||||
Reference in New Issue
Block a user