Skip to content

Редакторская вычитка теории модулей 25-types и далее #348

Description

@fey

This was generated by AI during triage.

Выделено из зонтичного #279 (отзыв студента, 2023). Один пункт того issue — вывод clock12.render() в уроке про абстрактные классы — уже исправлен (сейчас в задании '12 : 00 AM'), остальное про качество текстов остаётся.

Проблема

Отзыв: со второй половины курса резко падает качество текста — читается как машинный перевод с английского без последующей редактуры, плюс опечатки в примерах кода. Названные студентом уроки (по нумерации code-basics.com на 2023 год) соответствуют модулю 25-types и дальше: «черепашка» — урок про литеральные типы, «json» — про иерархию типов, «кошелёк» — про вариантность, «классы» — модуль 30-classes. Про уроки после 50-го сказано «в коде примеров опечатки». В обсуждении @bondiano подтвердил: эти уроки добавлялись итеративно и редакторскую вычитку не проходили.

Конкретное расхождение, найденное при триаже сейчас (годится как первый пункт работы): в уроке 25-types/40-assignability текст говорит «при присвоении x = y; и передачи аргумента f(false);», хотя в примере функция называется len. Заодно там же пропущен пробел перед скобкой в «присваиваемостью(Assignability)».

Желаемый результат

Теория и задания модулей 25-types, 30-classes, 40-generics, 50-objects проходят редакторскую вычитку: связный русский текст без следов машинного перевода, идентификаторы в тексте совпадают с идентификаторами в примерах, примеры исполняются и дают заявленный вывод.

Почему не для агента

Вычитка теории — редакторская работа с сохранением авторской интонации, объём измеряется десятками уроков, и «переписать по-хорошему» невозможно свести к проверяемому критерию для автономного прогона. Разумный путь: вести помодульно, по одному PR на модуль, силами редактора (как это делалось для локалей других курсов).

Acceptance criteria (на модуль)

  • Все идентификаторы, упоминаемые в тексте, существуют в примерах этого же урока под тем же именем
  • Примеры кода из теории исполняются и дают вывод, указанный в комментариях
  • ru- и en-версии не расходятся по содержанию
  • make compose-description-lint, markdown-lint и полный make check проходят

Out of scope

  • Изменение структуры курса и порядка уроков (см. отдельный issue про введение union)
  • Переписывание вводного урока (отдельный issue)
  • Изменение заданий и решений учителя — только текст, если правка не требует смены задания

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationready-for-humanNeeds human implementation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions