first commit
This commit is contained in:
25
README.md
Normal file
25
README.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# DuExpBot Technical Docs
|
||||
|
||||
Этот каталог содержит техническую документацию по проекту без глубокого разбора бизнес-логики.
|
||||
|
||||
## Состав
|
||||
|
||||
1. `techdocs/01-system-overview.md`
|
||||
Что это за бот, ключевые подсистемы, общая архитектура.
|
||||
2. `techdocs/02-processes-and-services.md`
|
||||
Какие процессы запускаются, что делает каждый сервис.
|
||||
3. `techdocs/03-bot-commands.md`
|
||||
Команды бота по модулям (назначение, без внутренней логики).
|
||||
4. `techdocs/04-manager-api.md`
|
||||
HTTP API менеджера/miniapp: маршруты и смысл.
|
||||
5. `techdocs/05-data-model-notes.md`
|
||||
Основные сущности БД и их назначение.
|
||||
|
||||
## Обновление
|
||||
|
||||
Документация собрана по текущему коду репозитория и должна обновляться при:
|
||||
|
||||
1. добавлении/удалении команд;
|
||||
2. изменении API;
|
||||
3. изменении состава процессов;
|
||||
4. изменении ключевых моделей БД.
|
||||
Reference in New Issue
Block a user