Добро пожаловать в Wiki

О сервисе

Данный сервис предназначен для документации внутреннего пользования по сопровождаемым программным комплексам, с применением языка разметки "markdown"

Markdown

Markdown (произносится маркда́ун) — облегчённый язык разметки, созданный с целью написания наиболее читаемого и удобного для правки текста, но пригодного для преобразования в языки для продвинутых публикаций (HTML, Rich Text и других).
©Wikipedia

Для тех кому интересно

Данная wiki - это сервис MkDocs

Навигация по wiki устроена очень просто:

Слева Вы можете наблюдать меню навигации по статьям
Справа меню навигаци по заголовкам внутри статьи

Также в верхнем меню, справа, Вы найдете "быстрый поиск".

Разработка статей

Для разработки статей в wiki Вам потребуется настроить рабочее место.
Если Вы еще не знакомы с markdown, то рекомендуем ознакомиться с возможностями разметки

Единые требования к стилю оформления

Руководство просит обратить внимание на необходимость единообразия оформления статей.

Использование заголовков

Использовать заголовки не более четвертого уровня. Т.к. заголовки пятого уровня в тексте уже не воспринимаются как заголовок, а также затрудняют ориентирование в "навигаторе по заголовкам"

Использование примечаний

Quote - для примечаний общего характера. Допускается использование без заголовка.

Пример:

!!! quote "Пример:"
    Текст примечания

Warning - для примечаний, имеющих особую важность. Заголовок обязателен.

Пример

!!! warning "Пример:"
    Текст примечания

Failure - для примечаний, содержащих информацию о заведомо известных ошибках и/или недоработках функционала. Заголовок обязателен.

Пример

!!! failure "Пример:"
    Текст примечания

Свернутые примечания - для примечаний содержащих большой объем инфвормации. Во избежание загромождения инструкци и затруднения восприятия ключевой информации.

Пример:

??? quote "Пример:"
    Очень...  
    много текста..  
    и/или картинок.

Публикация кода и команд

В 100% случаев код должен храниться в файлах, в соответствующей ветке репозитория "repo.ks-sakh.ru", а в статье публиковаться только ссылка.

Текстовые сообщения выводимые приложениями и команды выполняемые в терминалах ОС должны выделяться предназначенным для этого блок выделения многострочного кода.

Пример:

    ``` bash
        Текст команды..
    ```

Описание элементов меню и кнопок

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

Пример:

    `Пункт_меню_1 -> подпункт_меню_2 -> .. -> подпункт_меню_N`

    `Папка_1\подпапка_2\..\подпапка_N`

    кнопка `"Сохранить"`