Общее правила работы с документацией (FAQ)¶
Данная документация является пользовательской. В ней описываем все что связано с взаимодействием пользователя с сайтом, как с внешней его частью, так и с административной (админка).
Работу с документами можно вести как на сервисе Gitlab так и локално(у себя на компьютере) в любом удобном текстовом редакторе.
В пользовательской документации мы описываем:
- Цели, задачи проекта;
- Задачи отдельных страниц сайта;
- Внешний вид страниц, блоков сайта и их поведение в браузере;
- Поведение сайта при взаимодействии с пользователем.
Для чего вести документацию?
Составление понятной и простой документации, а так же поддержание её в актуальном состоянии дает нашей команде:
- Единое понимание целей и задач проека;
- Единое представление о том как должен работать сайт и что на нем должно происходить;
- Облегчает планирование работ по всему проекту;
- Облегчает и ускоряет разработку сайта и его модулей.
Как можно работать с документацией?
Для ведения документации был выбран достаточной простой синтаксис Markdown, изучение синтаксиса которого обязательно для её ведения. Краткое описание его возможностей доступных на нашем проекте можн посмотреть в разделе "Описание синтаксиса".
Как работать с сервисом Gitlab описано в разделе "Работа с сервисом Gitlab".
Как работать с документацией у себя на копьютере подробно опишу, если в этом будет потребность у наших партнеров.
Кто и когда заполняет данную документацию?
В данной документации присутствует словарик и прежде чем задавать вопрос по поводу того или иного термина, пожалуйста просмотрите его на специально созданной для этого странице.
В данной документации мы не описываем технически моменты - архитектуру, функции, контроллеры и пр. Этим моменты относятся к технической и архитектурной документациям, которая ведется в отдельном репозитории.