Skip to content

v1.0.2 — переработка документации

Choose a tag to compare

View all tags
@bivlked bivlked released this 01 May 11:00
· 4 commits to main since this release
v1.0.2
6290ebc

v1.0.2 — переработка документации

Документационный релиз: полная переработка README.md под целевую аудиторию (учителя танцев и хореографы), углублённые материалы вынесены в отдельный документ, добавлены стандартные файлы GitHub для пользователей и контрибьюторов.

⚠️ Изменений в коде нет — index.js идентичен версии 1.0.1, поведение программы и формат аргументов командной строки не менялись. Smoke-тест по-прежнему даёт 4/4 PASS.

Изменено

  • README.md полностью переписан в layered-структуре:
    «Что это и зачем» → «Быстрый старт за 30 секунд» → подробная установка по платформам (Windows раскрыт по умолчанию через <details open>, macOS / Linux свёрнуты) → способы использования → таблица параметров с колонкой «Когда менять» → формат-таблица с объяснениями → раздел «Частые вопросы» в свёрнутых блоках <details> → ссылки на углублённые материалы.
  • Из README.md убраны технические внутренности (имена ffmpeg-фильтров, форматы отсчётов и т.п.) — они переехали в docs/ARCHITECTURE.md. На их месте — короткие объяснения для не-программистов и ссылки на углублённый документ.
  • Терминология приведена к единому контракту переводов (см. docs/STYLE.md): русские эквиваленты вместо неоправданных англицизмов («без потерь» вместо lossless, «с потерями» вместо lossy, «без изменения высоты тона» вместо pitch preservation, «кб/с» вместо kbps), обращение на «Вы» с заглавной буквы.

Добавлено

  • docs/ARCHITECTURE.md — углублённый раздел для разработчиков и любопытных пользователей. Шесть секций: цепочка обработки аудио (с расшифровкой каждого ffmpeg-фильтра по-русски), качество и пережатие, дизайн тиков обратного отсчёта, замедление через librubberband, структура index.js, производительность.
  • docs/STYLE.md — внутренний документ, контракт переводов и стиль документации.
  • CONTRIBUTING.md — минимальный гайд для контрибьюторов: как сообщить об ошибке, как предложить улучшение, требования к pull request.
  • .github/ISSUE_TEMPLATE/bug_report.md — шаблон для сообщений об ошибках с YAML-frontmatter.
  • .github/ISSUE_TEMPLATE/feature_request.md — шаблон для предложений улучшений.
  • .github/PULL_REQUEST_TEMPLATE.md — чек-лист для PR.
  • Бейджи в README.md: добавлены Latest release, Last commit, Issues open, Language: Russian (всего 8 бейджей вместо 5).

Не менялось

  • index.js, tests/smoke.js, run.bat, LICENSE — без изменений.
  • package.json — обновлено только поле version (1.0.1 → 1.0.2).

Полный diff: v1.0.1...v1.0.2

Assets 2
Loading