Документирование проектов
Под проектом мы будем понимать реализованное приложение или планируемое к реализации. Поскольку за единицу мы берем приложение - логика документирования, в основном, будет строиться по описанию кода и его сущностей.
Необходимые разделы
- models - папка для описания моделей - абстрактных сущностей, которыми оперирует приложение. Например, студент/группа/дисциплина и т.д.
- features - процессы, которые затрагивают несколько сущностей/являются многоэтапными или логика реализации непрозрачна для понимания. Например, процесс сдачи тестирования с разными вариантами оценки
- assets - папка для файлов - изображений, аудио, текстовых документов. Все файлы, относящиеся к проекту - должны находиться в нем