Первое сообщение в этой теме заменено актуальной версией.

## Требования к оформлению сценариев и документации-v4.1.md
## Дата 2026-05-19 07:30:00
## Регламент по документации и скриптам.
------------ОГЛАВЛЕНИЕ:
1). Лаконичность;
2). Пунктуация и условия;
3). Редактирование и структура;
100). Требования касательно вывода на бумагу;
110). Принципы оформления документов с обьяснениями или скрипта.
110.1). Принципы при создании документации.;
110.2). Принцип написания кода.
------------

Требования к оформлению сценариев и документации:
1). Лаконичность:
    Запрещено дублировать имя команды в описании;
    Исключить вводные слова и лишние пояснения;
    Использовать прямолинейные термины;
    Исключить двусмысленные слова, например, «сессия»;
    Прямая связка действия и команды ;
    Заменить конкретным содержанием фразы "Лаконичное обьяснение", "Этап задачи", "Отсылка к оглавлению",
    "Имя файла-версия.md", "Назначение кратко." ;
2). Пунктуация и условия:
* Данный документ является образцом оформления по расстановке ";"  и  ":",
меток и комментариев в документации и в коде ;
* Обязательные условия перечислять через запятую и
скобки только для необязательных условий;
* Текстовые комментарии к коду и в оглавлении кода сопровождать ## ;
* Текст и комментарии в поясняющем документе и в его оглавлении НЕ сопровождать ## ;
* Для временно ненужного кода вставлять в начало строки один # без пробела;

3). Редактирование и структура.
Мониторинг,- указывать запуск от root в отдельном окне.
    Программы разделять на продолжение прерванного и новый запуск.
    Аргументы,- давать ссылку на man, разделяйте путь и домен.
    объяснять флаг, например, -B.
    Удаление,- строго два шага, проверка через /dev/null и rm.
*При правке одной строки не надо выводить всю простыню.
Покажите где меняете(пункт и или номер строки), задействованные переменные,
изменения БЫЛО и СТАЛО для согласования.
*Все файлы редактировать путём поиска, вставки, замены, без очистки или перезаписи всего файла,
перед изменением файла сделать резервную копию, .
Всегда использовать безопасное редактирование как это делает sudoedit;
*Предпочтение постоянно отдавать case вместо if и плосской структуре;
*Используйте простые конструкции с cat grep;
*Структурные части, выполняющие этап или задачу, делать ввиде модулей функций,
чтобы их потом можно было подключить где угодно;
*Забудьте свои привычки постоянно всё переименовывать, терять куски кода или текста,
делать что не заказывали без спроса;
*100500 правок меня запутают, делайте за один раз и без отклонении от задания;
*После утверждения сценария создать одноимённый файл документации с подробными объяснениями;

100). Требования касательно вывода на бумагу.
Для печати из приложения семейства Блокнот с целю экономии бумаги и улучщенной читаемости:
**Длину строк ограничить 90-92 со вставкой переноса строк по словам и структуре;
**Бумага А4, поля - левое 25мм и остальные 9мм;
101). Шрифты:
101.1). C чёткими различиями похожих символов и моноширинный:
DejaVu Sans Mono -> 10, InputMonoCondensed -> 12, JetBrains Mono -> 12;
101.2). Если фрагмент текста не содержит похожих по начертанию символов,
тогда конкретно в этом фрагменте можно использовать Fira Sans Condensed -> 12;

110). Принципы оформления документов с обьяснениями или скрипта.
110.1). Принципы при создании документации.
Оглавления нет, тк текст короткий и пунктов меньше трёх.
Обязательно указать
##  Имя файла-версия.
## Назначение кратко.
Версию писать сразу после имени через дефис,  пример <Имя>-<версия>.md
Оформлять bash, service, timer, config по принципам далее:
1. Заключать код в теги по образцу ниже;
2. На место "```bash"  писать соответственно service,timer, config;
```bash
## Имя файла-версия. дата yyyy-mm-dd_чч:мм
## Назначение кратко.
## Ссылка на пункт документации.
## Числовая метка.
##
здесь сам код
```

```plaintext
110.2). Принцип написания кода.
Оглавление по образцу .
Если взять и выполнить файл с кодом, то ошибки из-за оформления должны отсуствовать.
При оформлении кода код писать непосредственно как код.
## Отсылка к оглавлению;
## Этап задачи;
## Лаконичное обьяснение;
здесь сам код.
##------
Пример кода ниже;

#!/usr/bin/bash
## COMMENTBLOCK
## Имя файла-версия.
## Назначение кратко.
## ------------ОГЛАВЛЕНИЕ:
## 1. [НАСТРОЙКИ] ......... Конфигурация путей и прав, импорт функций;
## 2. [ИНИЦИАЛИЗАЦИЯ] ..... Определение переменных, Проверка настроек;
## 3. [ПРОВЕРКА_SUDO] ..... Контроль привилегий;
## 4. [Вычисления] ..... Сбор информации из системы или файла;
## 5. [Создание конфигураций] Скрипты, службы, конфиги, файлы ответов ...;
## 6. [ВАЛИДАЦИЯ] ......... Тесты и Проверка на возможные ошибки;
## 7. [ЗАВЕРШЕНИЕ] ........ Права, владелец и деплой.
##COMMENTBLOCK

## 1.[НАСТРОЙКИ];
## числовая метка и пункт оглавления.
## короткое обьяснение.
здесь тело сценария
## 2.[ИНИЦИАЛИЗАЦИЯ];

```
```

Отредактировано Avenir.Sirgun (Вт, 19 Май 2026 07:34:31)

Подпись автора

Подпись: С уважением, Авенир.
мой XMPP Jabber id : maksim.nk@jabber.ru ;