Документация DemoPlast
Сайт-каталог производителя пластиковой тары на Django. Это техническая документация проекта: как запустить, как эксплуатировать, как устроено и почему.
Документация разделена на четыре типа по модели Diátaxis — каждый отвечает на свой вопрос. Выберите нужный по тому, что вам сейчас надо сделать.
Уроки
«Я здесь впервые — проведите меня за руку.» Пошаговый запуск проекта с нуля до работающего сервера.
Инструкции
«Я в контексте, мне нужно решить конкретную задачу.» Рецепты для типовых операций.
- Деплой на сервер
- Эксплуатация: SSH, логи, бэкапы
- Добавить контент через админку
- Включить каналы уведомлений
Справочник
«Мне нужны точные факты: поля, переменные, endpoints.» Исчерпывающие таблицы без объяснений.
Объяснения
«Я хочу понять, почему так, а не иначе.» Контекст архитектурных решений.
Источник правды этой документации — английская версия, русская является переводом (ADR-0006).
Исходный код и обзор проекта — в README репозитория.