Небольшое видео про систему документирования в целом

Страницы и ссылки

Правила оформления ссылок для АГБИС изложены в
Руководство пользователя
Руководство администратора
Руководство технической поддержки
Руководство разработчика

Принцип написания статей простой. Открываем страницу, с которой будет идти ссылка на новую статью, на редактирование.
Редактирование доступно только зарегистрированным пользователям.

В статье создаем абзац или добавляем предложение. Текст, который будет ссылкой, обрамляем двойными квадратными скобками, например:

Посмотреть подробнее можно в разделе [[Репликация]].

Текст внутри двойных скобок не должен быть длиннее 119 символов, иначе могут быть ошибки при сохранении файла статьи. После сохранения изменений можно перейти по ссылке. Если ранее не было статьи с таким названием, то отобразится текст, что такой страницы еще не существует. Нажимаем на кнопку «Создать страницу». После этого стразу можно редактировать содержимое статьи.

Подробнее про оформление текста можно прочитать здесь: Синтаксис Wiki.

Названия страниц

Названия страниц нужно задавать такие, чтобы они не пересекались с другими названиями. Также в названии не должно быть служебных символов.
Например, неправильно:

[[5. Настройка кассы и мобильного склада]]

Здесь есть число в названии страницы, если ссылаться на эту страницу не только оттуда, где есть список, но и из других мест, то придется в ссылке использовать это-же число. Также здесь по названию может быть пересечение с документацией по Курьеру и другим проектам. Чтобы такого пересечения не было, лучше название проекта упоминать в ссылке.
Правильно:

[[:Настройка кассы и мобильного склада в Курьере]]

Для корректного отображения на странице можно ссылке задать заголовок так:

[[:Настройка кассы и мобильного склада в Курьере|5. Настройка кассы и мобильного склада]]

Права доступа

Те статьи, которые предназначены только для внутреннего использования, должны начинаться с префикса internal, например так:

Подробнее тут [[internal:Исправление проблем репликации|Исправление проблем репликации]].

Статьи для программистов должны содержать префикс develop, например так:

Тут [[develop:Закрытые команды API|Закрытые команды API]].

Если на одной странице есть текст, который должны видеть и любые посетители сайта и только сотрудники (зарегистрированные пользователи), то можно экранировать текст только для сотрудников специальными тегами ifauth:

===== База данных =====
[[Firebird]]\\
<ifauth @user>
[[internal:Структура базы данных]]\\
[[develop:Скрипты для программистов]]\\
</ifauth>

Подробнее про синтаксис скрытия текста в зависимости от зарегистрированных пользователей: https://www.dokuwiki.org/plugin:ifauthex

Импорт doc/docx файлов

Страницы можно создавать, импортируя их из doc/docx файлов. Для этого в новой странице нужно выбрать кнопку Импорт, там выбрать файл и собственно выполнить импорт. После импорта нужно однократно пройти по вновь созданной странице, откорректировать там, где автоматический импорт не справился. Также желательно оформить заголовки тем, для того чтобы было удобно перемещаться по статье через содержание в начале страницы.