Требования к оформлению сценариев и документации:
*Данный документ является образцом оформления по расстановке ";"  и  ":",
меток и комментариев в документации и в коде ;
*Текстовые комментарии сопровождать ## ;
*Для временно ненужного кода вставлять в начало строки один # без пробела;
*Все файлы редактировать путём поиска, вставки, замены, без очистки или перезаписи всего файла, Вставка или замена строки по номеру;
*Длину строк ограничить 92;
*При правке одной строки не надо выводить всю простыню,
покажите где меняете, задействованные переменные, изменения БЫЛО и СТАЛО
для согласования;
*Используйте простые конструкции с cat grep;
*Предпочтение постоянно отдавать case вместо if;
*Чем проще код, тем надёжнее, сложное вы не умеете;
*После утверждения сценария создать одноимённый файл документации с подробными объяснениями;
*100500 правок меня запутают, делайте за один раз и без отклонении от задания;
*Забудьте свои привычки постоянно всё переименовывать, терять куски кода или текста,
делать что не заказывали без спроса;
* Для печати из приложения типа Блокнот:Бумага А4, Шрифт ;

Принципы оформления документа с обьяснениями или скрипта

Образец кода ниже;

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

## 1.[НАСТРОЙКИ];

## 2.[ИНИЦИАЛИЗАЦИЯ];

## 3.[ПРОВЕРКА_SUDO];

## 4.[ПОДГОТОВКА_КОПИИ];

## 5.[РЕДАКТИРОВАНИЕ];

## 6.[ВАЛИДАЦИЯ];

## 7. [ЗАВЕРШЕНИЕ].

echo "Успешно: $DEST_PATH"
## числовая метка.пункт оглавления.
## короткое обьяснение.
здесь тело сценария

При создании документации
оформлять bash, service, timer, config по принципам далее:
1. Заключать код в теги по образцу ниже;
2. На место "```bash"  писать соответственно service,timer, config;
```bash
## Имя файла-версия.
## Назначение кратко.
## числовая метка. ссылка на пункт документации.
##

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

Отредактировано Avenir.Sirgun (Сегодня 00:24:20)

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

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