Порядок выполнения:
-
Выбрать проект, в котором есть хотя бы несколько классов, хотя бы два уровня иерархии ООП.
-
Залить его в репозиторий, в папку QA_Lab3_Surname с вашей фамилией. Ссылку на папку в Гитхабе поместить в отчет.
-
Выбрать фреймворк для генерации документации, в зависимости от ЯП, на котором написан ваш проект. Я предлагаю использовать Doxygen, он поддерживает много языков, но можете выбрать и что-то другое, например JSDoc для JavaScript, DocFx для .NET, JavaDoc для Java.
-
Написать документирующие комментарии (https://habr.com/ru/post/252101/) к каждому классу, к каждому публичному методу. Добавить хотя бы одну картинку, одну формулу, и один любой граф (https://habr.com/ru/post/253223/).
-
Написать обычные поясняющие комментарии (https://habr.com/ru/company/vk/blog/354892/), если это необходимо в соответствии с рекомендациями.
-
Сгенерировать HTML страницы. Скриншоты сгенерированного портала документации поместить в документ с отчетом.
-
Залить отчет в LMS.