Итоговый проект — документация проекта

Комплект документации, по которому незнакомый человек разберётся в проекте и запустит его

Прогресс курса Модуль 5 из 5

Что покажет проект

01

Постановка

Выберите проект: свой учебный проект из другого курса, базу данных из курса «Базы данных», скрипт автоматизации, сайт. Если своего нет — опишите вымышленный сервис «Портал сдачи учебных работ». Задача — подготовить документацию, по которой проект можно понять, установить и сопровождать без автора.

Проект размещается в git-репозитории (GitFlic, GitLab или другой хостинг) либо сдаётся архивом папки. Репозиторий предпочтительнее: так проверяется отображение на реальной платформе.

Практические задания — на учебном портале. Задания, критерии оценивания, сдача работ и оценки преподавателя — в курсе на portal.nevabit.ru. Учётную запись выдаёт преподаватель.

Курс пройден

Вы умеете писать документацию так, как это делают в командах разработки: в текстовых файлах рядом с кодом, с проверкой стиля и выгрузкой для тех, кто не работает с git. Следующий шаг — применять Markdown в каждом своём проекте: README, заметки к занятиям, отчёты по лабораторным.

Модуль 04: README Все модули Все курсы