[prac] Задание по практикуму для групп СП

[Eugene Sharygin]

Vladislav Ivanishin <vlad at ispras.ru> writes:

> Хамикоев Александр <sanchese113 at yandex.ru> writes:
>
>> Тема "составить документацию <...>" включает ли в себя создание wiki
>> по QBE?  Если нет, то, к примеру, можно ли вдвоем сделать удобную wiki
>> по QBE?
>
> Тема сама по себе ещё ничего не включает, она лишь задаёт
> направление. Предполагается, что студенты решают, что именно будет
> включать их проект на этапе разработки и согласования плана.
>
> Что конкретно будет содержать wiki? Кажется, что наполнение будет
> дублировать или частично перекрываться с обычными комментариями к QBE.

Wiki - это хорошее место для статей и туториалов, освещающих основные
концепции QBE, примеры простейших проходов или даже алгоритмы из курса с
примерами на QBE.

Стоит ли совместить wiki с описанием API (комментариями), команда должны
решить на этапе постановки задач. Возможно, для API лучше использовать
другую систему, хотя открытый аспект wiki может быть довольно
соблазнителен в рамках курса: после настройки wiki будущие поколения
студентов могли бы обновлять и дополнять документацию через
веб-интерфейс (по образу MDN).

> В принципе, было бы неплохо увидеть документацию на двух языках (русском
> и английском). Возможно, это как-то добавит объёма работы, чтобы вы
> вдвоём могли тоже работать над документацией? (На самом деле, этот
> вопрос я адресую в первую очередь Евгению.)

Не думаю, что есть смысл одну и ту же работу выполнять на двух языках,
тем более комментарии к коду, которые и без того в будущем может
потребоваться иногда обновлять.

Против задачи написания комментариев только на английском языке не
возражаю, но надо озаботиться полезностью этих комментариев для будущих
поколений студентов.

> P.S.: пожалуйста, набирайте сообщения в plan text режиме -- иначе они
> некорректно отображаются в архивах [1] -- и цитируйте только релевантную
> порцию сообщения, на которое Вы отвечаете.
>
> [1]: https://compilers.ispras.ru/pipermail/prac-sp-18/2018/000038.html

--
Regards,
Eugene Sharygin,
ISP RAS.