[doc] [план]

[Игорь Анфёров]

Добрый день!

Наша команда:
1. Анфёров Игорь, 
2. Жиганов Роман, 
3. Манджиев Айта,
4. Захаров Даниил,
5. Хамикоев Александр.

Мы составили план работ по двум нашим проектам в рамках темы написания документации по QBE и Си-интерфейсу.

Проект CompilersWiki (Захаров Даниил, Александр Хамикоев):

I неделя - II неделя:
1. Согласование оформления документации по каждому разделу (совместно). 
2. Страница QBE будет содержать общее описание языка (Захаров Даниил);
3. Описание языка. Под этим подразумевается русификация и разбиения на отдельные страницы имеющейся документации c9x.me/compile/ (Захаров Даниил);
4. Различные проблемы, которые могут возникнуть при написании программ на языке QBE, либо с использованием Си библиотеки (Александр Хамикоев);

III неделя (В задачах 1 - 4 каждый студент работает над своей частью кода):
1. (Возможно) Установка плагина DoxyWiki (https://www.mediawiki.org/wiki/Extension:DoxyWiki) (Захаров Даниил)
2. Интеграция документации к коду Си-интерфейса QBE, написанной другой частью команды, в отдельными страницы Wiki (возможно, с помощью плагина DoxyWiki). (Александр Хамикоев)
3. Дополнение интегрированной документации (п.2) комментариями в более свободной форме (если потребуется). (Александр Хамикоев)
4. Примеры кода на языке QBE. (Захаров Даниил)

IV неделя:
1. Некоторые теоретические части из лекций (будет распределено между участниками данного проекта по факту выполнения).
2. Составление отчета (совместно)

Проект по разработке документации с помощью doxygen (Анфёров Игорь, Жиганов Роман, Манджиев Айта):

I неделя:
1. Изучить C-интерфейс QBE

II неделя (В задачах 1 и 4 каждый студент работает над своей частью кода):
1. Изучить doxygen
2. Согласование формата документирования
3. Написание документации в виде комментариев к объектам в all.h
4. Взаимодействие с проектом Wiki по интеграции документации.

III неделя:
1. Написание файла конфигурации для doxygen в соответствии с требованиями
2. Генерация html-документации с помощью doxygen

IV неделя:
1. Составление отчёта