Elysia Tools
Навигация
Workflow Playbook
Сверьте один выпуск с журналом изменений, проверьте синтаксис версии и ссылки Markdown, затем подготовьте согласованные примечания для сайта, Slack и PDF.
Темы
Этот процесс нужен сопровождающим, которые передают один выпуск программы редакторам документации и ответственным за объявления. Начните с основного журнала изменений и конкретного номера, а не со смешанных сообщений коммитов. Проверьте извлечённые разделы, даты и категории по утверждённым подтверждениям. Пустой раздел может означать нераспознанный формат, а не отсутствие изменений. Не включайте автоматически всё, что ещё не опубликовано.
Опишите, что изменилось, кому нужно действовать и какие инструкции по миграции или откату утверждены. Корректный SemVer не обосновывает повышение минорной версии. Решите этот вопрос до публикации. Проверка стиля находит ошибки оформления; безопасные исправления не заменяют проверку заголовков, примеров кода и неполных объяснений. Зафиксируйте редакцию исходника до подготовки вариантов.
Коротким примечаниям обычно не нужно оглавление. В длинном документе сначала завершите заголовки, затем создайте оглавление и проверьте ссылки. Якоря следуют правилам GitHub; испытайте их в реальном отображении сайта. Статическая проверка не доказывает доступность загрузки. Откройте важные внешние адреса отдельно, учитывая требования входа в систему.
Готовьте только нужные форматы. Широкая таблица может остаться в полном документе; краткое сообщение Slack должно сохранять предупреждения о миграции и официальную ссылку. Перепишите таблицы, списки задач и объяснения, зависящие от изображений, если они отмечены как неподдерживаемые. Преобразование не развёртывает сайт и не отправляет сообщение.
Если нужен PDF, просмотрите реальные страницы: не обрезаны ли таблицы, не выходит ли код за поля и не теряется ли контекст при переносах. Сравните версию, дату, инструкции и ссылки каждого файла с исходником. Пересоздайте устаревший вариант вместо правки только экспортированного файла. Сохраните утверждённую редакцию и имена файлов вместе. Большие руководства относятся к подготовке документации, отдельные правки к инструментам Markdown, а совместимость контрактов следует определить в проверке версий API до этой передачи.
Руководство по рабочему процессу
Извлеките версии и категории изменений, выберите нужный выпуск, сверьте подтверждения и проверьте номер, не считая корректный синтаксис доказательством совместимости.
Исправьте замечания по оформлению, вручную проверьте заголовки и блоки кода и дополните объяснения изменений и миграции.
Создайте оглавление при необходимости, затем проверьте внутренние якоря, форматы ссылок и неопределённые ссылки; внешние адреса и особенности целевого отображения проверяйте отдельно.
Преобразуйте утверждённый исходник в HTML, а объявление в Slack mrkdwn, исправьте неподдерживаемые элементы и сравните важные факты перед передачей, без автоматической публикации.
SemVer проверяет только синтаксис. Совместимость оценивают по реальным изменениям; при изменении контрактов сначала используйте проверку версий API.
Короткому объявлению оно обычно не нужно. В длинном документе сначала завершите заголовки, затем создайте навигацию и проверьте якоря в целевом отображении.
Сайт или PDF сохраняют подробности. Сокращайте Slack без потери предупреждений о миграции и официальной ссылки; переработайте неподдерживаемые таблицы и списки задач.
Экспортируйте PDF с подходящей темой, проверьте разрывы страниц и читаемость и сверьте необходимые файлы с одной утверждённой редакцией.