Правила оформления документации

Задача документации — создать для всех участников процесса разработки/использования/развития приложения единое понятийное поле, чтобы обсуждение задач не превращалось в плохой телефон. Так же важно иметь человекочитаемое описание текущей системы для её долгосрочной поддержки

Общие правила

Файлы

в каждой папке должен быть файл с названием index.md. Это вводный файл в папку, в нем должно быть небольшое введение и оглавление с ссылками на внутренние файлы/папки
когда делаете ссылку на папку - ссылаться нужно на файл index.md этой папки (например в корневом файле ссылаетесь на папку models - значение ссылки должно выглядеть так - models/index.md)
названия файлов - разрешены символы английского алфавита в нижнем регистре, цифры, дефис и нижнее подчеркивание. Само название должно быть английским словом/словами (транскрипция английскими буквами русских слов запрещена)
хорошим тоном будет кнопка "Назад", указывающая на файл index.md в папке выше по иерархии: [Назад](../index.md)

Папки

названия папок - разрешены символы английского алфавита в нижнем регистре, цифры, дефис и нижнее подчеркивание

Специальные разделы

Назад