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

[Хамикоев Александр]

Здравствуйте.

К сожалению, мы (Захаров Даниил и Хамикоев Александр, студенты 428 группы) не смогли себе найти третьего человека в команду. Потому, посоветовавшись, мы решили предложить проект, который видится по силам нам на двоих. Как мы поняли, инновации в списке тем, не противоречат регламенту, описанному Вами в первом письме к курсу. А численность исполнителей к каждой теме может быть отклонено от 3-5 (как в регламенте) по согласованию с преподавателями.

Наше предложение следующего содержания. Проект по созданию Wiki для QBE (близко к имеющейся в списке теме, но отличий тоже много). В качестве CMS мы хотели бы использовать открытую MediaWiki.

Первоначально задумывается такая структура:

1. Main_Page будет содержать общее описание языка;
2. Описание языка. Под этим подразумевается русификация и разбиения на отдельные страницы имеющейся документации c9x.me/compile/;
3. Отдельными страницами планируется описать неофициальный Си-интерфейс, с описанием и разбором содержимого его файлов;
4. Примеры кода на языке QBE;
5. Различные проблемы, которые могут возникнуть при написании программ на языке QBE, либо с использованием Си библиотеки;
6. Некоторые теоретические части из лекций.

MediaWiki сохраняет историю и версии редакций страниц, что будет свидетельствовать о работе каждого члена "команды". Результатом же работы, на наш взгляд, можно будет считать бэкап ресурса (с выгрузкой страниц и системных таблиц из СУБД).

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

С уважением, студенты 428 группы:
Захаров Даниил и Хамикоев Александр

15:07, 12 марта 2018 г., Eugene Sharygin <eush at ispras.ru>:
> 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.