Игорь Надеин
48631f43fd
- Создана структура docs/ с категориями: completed, guides, architecture, diagnostic, in-progress, reports - Перемещено 47+ MD файлов из корня проекта в docs/ - Удалено 6 устаревших/дублирующихся файлов - Создана структура backend/scripts/ для тестов и утилит - Перемещено 35 Python скриптов в backend/scripts/ - Создана структура backend/docs/ для технической документации - Перемещено 12 MD файлов backend в backend/docs/ - Перемещены LDAP тестовые данные в backend/tests/fixtures/ - Добавлены README файлы для навигации - Добавлены правила в .github/copilot-instructions.md для размещения документации Результат: - Корень проекта: только README.md - Корень backend/: только manage.py и Django приложения - Вся документация организована в структурированные папки
93 lines
3.5 KiB
Markdown
93 lines
3.5 KiB
Markdown
# Backend Documentation
|
||
|
||
Техническая документация по backend части проекта EUSRR.
|
||
|
||
## 📁 Структура
|
||
|
||
### [guides/](guides/)
|
||
**Руководства разработчика** - инструкции по работе с различными модулями
|
||
|
||
- CONTEXT_MENU_GUIDE.md - работа с контекстными меню
|
||
- REACTIONS_GUIDE.md - система реакций
|
||
|
||
### [troubleshooting/](troubleshooting/)
|
||
**Отладка и исправления** - диагностика проблем
|
||
|
||
- CONTEXT_MENU_DEBUG.md - отладка контекстного меню
|
||
- MESSAGE_DELETE_DEBUG.md - отладка удаления сообщений
|
||
- MESSAGE_DELETE_FIX.md - исправление проблем удаления
|
||
|
||
### [architecture/](architecture/)
|
||
**Архитектурная документация** - устройство систем
|
||
|
||
- API_ANALYSIS.md - анализ API
|
||
- API_REFACTORING_SUMMARY.md - результаты рефакторинга API
|
||
- VIEWSET_ANALYSIS.md - анализ ViewSet
|
||
|
||
### [testing/](testing/)
|
||
**Тестирование** - планы и результаты тестирования
|
||
|
||
- POSITION_PERMISSIONS_TESTING.md - тестирование прав должностей
|
||
- REQUESTS_API_TESTING_PLAN.md - план тестирования API заявок
|
||
- TEST_IMAGE_SCRIPTS.md - скрипты тестирования изображений
|
||
|
||
### [reports/](reports/)
|
||
**Отчеты и аудиты** - результаты проверок и реорганизаций
|
||
|
||
- BACKEND_CLEANUP_AUDIT.md - аудит очистки backend/
|
||
- REQUESTS_API_TESTING_PLAN.md - план тестирования API заявок
|
||
- TEST_IMAGE_SCRIPTS.md - скрипты тестирования изображений
|
||
|
||
## 🔍 Навигация
|
||
|
||
### По типу задачи:
|
||
|
||
- **Как работает X?** → [architecture/](architecture/)
|
||
- **Как настроить Y?** → [guides/](guides/)
|
||
- **Проблема с Z** → [troubleshooting/](troubleshooting/)
|
||
- **Как тестировать?** → [testing/](testing/)
|
||
|
||
### Связанная документация:
|
||
|
||
- [/docs/](../../docs/) - общая документация проекта
|
||
- [backend/scripts/](../scripts/) - вспомогательные скрипты
|
||
|
||
## 📝 Правила
|
||
|
||
### Добавление новой документации:
|
||
|
||
1. **Guides** - постоянные инструкции, reference материалы
|
||
2. **Troubleshooting** - временные документы, после решения → удалить
|
||
3. **Architecture** - долгосрочная документация, обновлять при изменениях
|
||
4. **Testing** - планы тестирования, после завершения → архивировать
|
||
|
||
### Формат файлов:
|
||
|
||
```markdown
|
||
# Заголовок
|
||
|
||
**Дата:** DD.MM.YYYY
|
||
**Автор:** Имя
|
||
**Статус:** Актуально / Устарело / В процессе
|
||
|
||
## Описание
|
||
...
|
||
|
||
## Использование
|
||
...
|
||
|
||
## Примеры
|
||
...
|
||
```
|
||
|
||
## 🔄 Жизненный цикл
|
||
|
||
1. **Создание** - документируйте новую фичу/проблему
|
||
2. **Актуализация** - обновляйте при изменениях
|
||
3. **Архивация** - после завершения/решения
|
||
4. **Удаление** - если больше не актуально
|
||
|
||
---
|
||
|
||
**Поддерживайте документацию актуальной!** 📚
|