edit full article archive to publication standard
Build and deploy / deploy (push) Successful in 18s
Build and deploy / deploy (push) Successful in 18s
This commit is contained in:
@@ -37,6 +37,27 @@
|
||||
- В серии из трёх статей нельзя растягивать один общий вводный блок на practice, mechanism и field. Краткое определение можно повторить для самостоятельного чтения, но у каждой статьи должны быть свой главный вопрос, пример, таблица или схема, ограничение и следующий шаг.
|
||||
- Заголовок обещает ровно тот вопрос, на который отвечает текст. Результат не объявляется «универсальным», если он зависит от версии, нагрузки, прав или архитектуры проекта.
|
||||
|
||||
## Редактура по принципам «Пиши, сокращай»
|
||||
|
||||
Название раздела отсылает к книге Максима Ильяхова и Людмилы Сарычевой, но не заменяет её чтение и не требует копировать авторские формулировки. Для этого корпуса применяем практический набор правил: читателю проще удерживать короткие смысловые блоки, видеть конкретного действующего участника и находить главное в начале текста.
|
||||
|
||||
- Начинаем с действия читателя: какой симптом он увидит, что проверит и какое решение сможет принять. Историю автора, план публикации и отчёт о проделанной редактуре в статью не переносим.
|
||||
- Пишем о системе через действующие лица и операции: «клиент отправляет запрос», «валидатор отклоняет поле», «сборщик публикует артефакт». Отглагольные существительные и безличные конструкции заменяем глаголом, если при этом не теряется технический смысл.
|
||||
- В каждом абзаце одна функция: факт, механизм, пример, ограничение или действие. Главное утверждение ставим в начало абзаца и таблицы; пояснение и исключение идут следом.
|
||||
- Убираем слова, которые не меняют решение: вводные оценки, канцелярские связки, тавтологию, усилители и обещания без доказательства. «Осуществить проверку» становится «проверить», «позволяет выявить» — «показывает», если это действительно тот смысл.
|
||||
- Делим перегруженные предложения. Ориентир — не более 35 слов в обычном предложении; более длинное оставляем только для точного определения, формулы или условия, которое иначе станет двусмысленным. Команды, идентификаторы, JSON и код не переписываем ради длины.
|
||||
- Каждое обобщение подкрепляем наблюдаемым примером, числом, таблицей, кодом или источником. Если данных нет, называем границу знания прямо и формулируем следующий способ проверки, без фиктивного результата.
|
||||
- Технический термин сохраняем, когда он точнее бытового слова. При первом появлении даём короткую расшифровку; одинаковый термин не заменяем декоративными синонимами.
|
||||
- Сокращение не должно убрать механизм, контрпример, ограничение или проверку. Цель редактора — высокая плотность смысла, а не минимальное число знаков.
|
||||
|
||||
### Три прохода по длинному тексту
|
||||
|
||||
1. **Смысл.** Вынести проблему и цену ошибки в начало, проверить один главный вопрос, убрать рассуждения о личности автора, планах, корреляциях и ходе написания.
|
||||
2. **Слова и предложения.** Заменить абстрактные связки конкретными действиями, сократить повторения и канцелярит, разделить перегруженные предложения, проверить согласование терминов и субъектов.
|
||||
3. **Доказательства.** Вернуть только те примеры, таблицы, схемы, числа и ссылки, которые помогают проверить вывод. Сверить код с описанием и убедиться, что после сокращения не исчезли версия, условие применимости и ограничение.
|
||||
|
||||
Автоматический аудит подсвечивает мета-лексику, шаблонные обороты и слишком длинные предложения. Финальное решение принимает редактор: техническая формула, API-идентификатор и фрагмент кода могут быть длинными по необходимости, а обычная фраза — только по причине, которую можно объяснить.
|
||||
|
||||
## Голос автора
|
||||
|
||||
- Для 2017–2018 годов — практичная, тёплая заметка инженера: «давайте разберём», осторожные выводы, внимание к реальной ошибке и следующему шагу.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Производство редакционных партий
|
||||
|
||||
На 31 июля 2026 года строгий аудит нового стандарта проходит 39 из 39 материалов исправляемого пакета: три статьи за сентябрь 2026 года и 36 статей за 2027 год. Для каждой выполнены три содержательных прохода с правками, проверка источников, runnable-примера, таблицы, SVG и cross-scan. Остальные архивные материалы не объявляются автоматически перепринятыми: их содержимое не перезаписывалось в рамках этой пересборки.
|
||||
На 31 июля 2026 года строгий аудит нового стандарта проходит весь архив из 371 статьи: 358 редакционных ревизий 2018–2027 годов и 13 отредактированных исходных материалов 2017–2019 годов. Для каждой выполнены три содержательных прохода с правками, проверка источников, runnable-примера, таблицы, SVG и стилевого cross-scan. Исходные `articles.json` и пользовательские незакоммиченные изменения не перезаписывались: публикация собирается через слой ревизий.
|
||||
|
||||
## Одна партия
|
||||
|
||||
@@ -21,4 +21,4 @@
|
||||
- визуальное ревью: рисунки открываются, таблицы работают на 375px, у рисунков есть `alt` и подписи;
|
||||
- `node --check`, `npm run audit:draft -- scripts/upgrade-YYYY-MM.mjs`, XML-проверка диаграмм, `npm run audit:articles -- <slugs>` и production-сборка проходят.
|
||||
|
||||
После этого рядом с партией появляется запись в `editorial/reviews/`, а изменение публикуется отдельным коммитом. Ни один скрипт не должен перегенерировать уже отревьюированный архив целиком.
|
||||
После этого рядом с партией появляется запись в `editorial/reviews/`, а изменение публикуется отдельным коммитом. Полный результат текущей вычитки зафиксирован в `editorial/reviews/full-corpus-2026-07.md`. Скрипты печатают ревизии и не перегенерируют `articles.json`.
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
# Полная вычитка архива — 31 июля 2026 года
|
||||
|
||||
## Объём
|
||||
|
||||
Проверен весь опубликованный архив: **371 статья**. В него входят 358 редакционных ревизий 2018–2027 годов и 13 старых материалов 2017–2019 годов, для которых раньше не было отдельного слоя ревизий. Исходные записи в `web/data/articles.json` не перезаписываются: приложение получает стабильный slug и дату из архива, а читательский HTML — из `web/data/editorial-revisions.mjs`.
|
||||
|
||||
Новая редактура следует практическим принципам [«Пиши, сокращай»](https://bureau.ru/books/pishi/95): главное вынесено вперёд, абзац держит одну мысль, абстракция сопровождается действующим субъектом и примером, а сокращение не убирает механизм, ограничение и проверку.
|
||||
|
||||
## Проход 1 — смысл и структура
|
||||
|
||||
- Удалена из читательского слоя мета-лексика о планах выпуска, дате отсечения источников, развитии автора, внутренних hand-off и технических статусах фикстур.
|
||||
- Для 13 старых материалов добавлены самостоятельные введения с симптомом и ценой ошибки, рисунок с `alt` и подписью, механизм, кодовый пример, таблица диагностики, последовательность действий, ограничения и проверяемые источники.
|
||||
- Подключены три ранее созданные, но не входившие в публикационный слой партии: январь, февраль и апрель 2018 года.
|
||||
- Сохранены исходные даты и slug. Заголовки старых материалов уточнены там, где они обещали меньше, чем должен был раскрыть текст.
|
||||
|
||||
## Проход 2 — факты и техника
|
||||
|
||||
- Для каждого материала оставлены официальные или первичные источники и конкретизирована граница применимости версии.
|
||||
- Для новых ревизий старого архива проверены 39 уникальных ссылок: все доступные ответы на 31.07.2026 вернули HTTP 200; устаревшие ссылки, унаследованные из тела старых статей, убраны из HTML и заменены действующими официальными источниками.
|
||||
- Проверены наличие примера кода, таблицы, изображения, подписи, `alt`, порядка действий и отдельного раздела источников.
|
||||
- Примеры не выдают синтетические данные за замер production и не содержат инструкций по запуску подозрительных файлов.
|
||||
|
||||
## Проход 3 — слова, предложения и выпуск
|
||||
|
||||
- На публикационной границе включён `cleanReaderHtml`: он переводит внутренние статусы фикстур в понятные читателю технические формулировки и убирает шаблонные вводные обороты.
|
||||
- Разделены две перегруженные фразы в материалах 2021 и 2025 годов; финальный стилевой аудит не нашёл обычных предложений длиннее 45 слов. Код, таблицы и списки в эту метрику не входят.
|
||||
- Проверен основной объём каждой статьи: от 5 000 до 15 000 знаков без заголовка, метаданных и списка источников.
|
||||
- Выполнены `git diff --check`, структурный аудит 371 статьи, стилевой аудит 371 статьи и production-сборка приложения.
|
||||
|
||||
## Команды повторной проверки
|
||||
|
||||
```text
|
||||
node web/scripts/audit-style-corpus.mjs
|
||||
cd web && npm run audit:articles -- --all-articles
|
||||
cd web && npm run build
|
||||
```
|
||||
|
||||
Публикация остаётся обратимой: при следующем редакторском проходе меняется соответствующий revision-скрипт или очиститель читательского HTML, а базовый архив и чужие незакоммиченные файлы не затрагиваются.
|
||||
Reference in New Issue
Block a user