mirror of
https://github.com/EDeev/mospolytech-mcp.git
synced 2026-10-08 04:59:47 +03:00
23 lines
1.7 KiB
Markdown
23 lines
1.7 KiB
Markdown
# Документация проекта
|
||
|
||
Делим на два вида, чтобы не путаться:
|
||
|
||
- **`official/`** — официальные бумажки, которые сдаём преподавателю по
|
||
каждой лабораторной, в формате PDF, оформленные по ГОСТ (как и требует
|
||
ТЗ, раздел 7). Мы их не правим "по ходу дела" — раз сдали, значит,
|
||
зафиксировали. Следующая лабораторная — новый файл.
|
||
- **`working/`** — наши рабочие записи для себя: план, заметки по рискам,
|
||
черновик схемы БД и т.п. Эти документы мы правим постоянно, они не для
|
||
сдачи, а чтобы не терять контекст между лабораторными и держать в одном
|
||
месте то, что иначе разошлось бы по трём головам.
|
||
|
||
Технической документации к коду (описание MCP-инструментов, схема БД,
|
||
инструкция по развёртыванию — как требует ТЗ, раздел 7) тоже место здесь,
|
||
в Markdown, по мере появления соответствующего кода.
|
||
|
||
## Файлы
|
||
|
||
| Файл | Что это |
|
||
|---|---|
|
||
| [`official/lab01-tech-spec.pdf`](official/lab01-tech-spec.pdf) | Техническое задание — сдано на лаб. №1 |
|
||
| [`working/plan.md`](working/plan.md) | Наш план по всем 8 лабораторным, архитектура, риски |
|