Портал

Информация о пользователе

Привет, Гость! Войдите или зарегистрируйтесь.

Вы здесь » Портал » Документация » Требования оформления документации v6

Требования оформления документации v6

Страница: 1

Сообщений 1 страница 7 из 7

1

  • Автор: Avenir.Sirgun
  • Глава
  • Avenir.Sirgun
  • Откуда: Сверловская область
  • Зарегистрирован: Вс, 30 Янв 2011
  • Приглашений: 0
  • Сообщений: 1127
  • Уважение: [+14/-0]
  • Позитив: [+45/-2]
  • Пол: Мужской
  • Возраст: 57 [1969-05-29]
  • Провел на форуме:
    14 дней 6 часов
  • Последний визит:
    Вчера 07:18:10

В целях обеспечения единообразия и безопасности
определены форматы файлов и требования к содержанию и оформлению
для деловой переписки и оформления заказов.

Бонусом является упорядочивание и кристаллизация идеи вашего заказа.

2026-09-02 Для документов.
Переходим на разметку Obsidian markdown и БД,
чтобы отказаться от использования офисных пакетов.

###### Преимущества схемы
Для договорной части и писем отказ от PDF/Office — выигрыш по всем фронтам.
Для чертежей и схем не отступайте от принципа,
а смените инструмент: SVG/DXF/KiCad дают вам ту же текстовую парадигму там,
где md физически не работает.
##- Подход разумен, и цифра реальна
Для текстовых документов разница в 10–50 раз — правда, и она объяснима:
основная масса типового PDF — это встроенные шрифты (сотни КБ) и контейнерная обвязка,
а ваш договор на 5 страниц в md — 10–20 КБ. Плюс, что важнее места:

- **Безопасность**: md не исполняется.
Главный вектор атак у офисных форматов — макросы (.doc/.docm/.xlsm),
у PDF — дырявые парсеры ридеров. Plain text лишает атаку этой поверхности.
- **Grep, diff, git**: документы становятся данными.
Поиск по всей БД — `grep -r`, история изменений — `git log`, целостность — hash.
- **Wiki-links**: связи «акт → договор → письмо» Obsidian строит сам,
PDF-архив этого не умеет никогда.

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

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

0

2

  • Автор: Avenir.Sirgun
  • Глава
  • Avenir.Sirgun
  • Откуда: Сверловская область
  • Зарегистрирован: Вс, 30 Янв 2011
  • Приглашений: 0
  • Сообщений: 1127
  • Уважение: [+14/-0]
  • Позитив: [+45/-2]
  • Пол: Мужской
  • Возраст: 57 [1969-05-29]
  • Провел на форуме:
    14 дней 6 часов
  • Последний визит:
    Вчера 07:18:10

Формат текстовых файлов только обычные *.md, *.csv .
Кодовая страница UTF-8. Перенос строк Linux.
Электронные таблицы: в формате *.csv с разделителем столцов `;`.
Вычисления отдельным листом с отсылками на конкретные ячейки таблицы;
Подписанный документ: Строго черно-белый скан в форматах TIFF G4
Никогда : jpeg,png,bmp,pdf,(любой офисный формат)

Требования касательно вывода на бумагу и в окно редактора
Упомянутые шрифты присуствуют в свободном доступе без возмездно.

Для печати из приложения семейства Блокнот{Pluma, Xed, ..., Helix}
с целю экономии бумаги и улучщенной читаемости:
**Длину строк ограничить 80-90 со вставкой переноса строк
по словам и структуре;
**Бумага А4, поля - левое 25мм и остальные 9мм;
Шрифты:
C чёткими различиями похожих символов и моноширинный:
InputMonoCondensed -> 11, JetBrains Mono -> 11;

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

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

0

3

  • Автор: Avenir.Sirgun
  • Глава
  • Avenir.Sirgun
  • Откуда: Сверловская область
  • Зарегистрирован: Вс, 30 Янв 2011
  • Приглашений: 0
  • Сообщений: 1127
  • Уважение: [+14/-0]
  • Позитив: [+45/-2]
  • Пол: Мужской
  • Возраст: 57 [1969-05-29]
  • Провел на форуме:
    14 дней 6 часов
  • Последний визит:
    Вчера 07:18:10

###### Что если не текст
##- половина документов — не текст

| Тип | В md? | Решение |
|---|---|---|
| договор, акт, счёт, ДС, спецификация, письма | ✅ да | как обсуждали |
| чертёж, принципиальная схема | ❌ графика | **тоже есть текстовый путь, см. ниже** |

**Концепцию продолжить, а не бросать:**
«Чертёж» тоже может быть текстом — просто не md,
а SVG/DXF/KiCad, с карточкой метаданных `##-` рядом.
- **SVG** — векторная графика, *текстовый формат*.
Obsidian рендерит его прямо в заметке: `![[кронштейн.svg]]`.
Схемы, рамки, простые чертежи — рисуются и хранятся как текст, весят килобайты.
- **DXF** — чертёжный формат AutoCAD, тоже текстовый.
- **KiCad** — принципиальные схемы (`.kicad_sch`) — текстовые s-выражения.
Плата + схема + BOM в git.
- **Mermaid** — встроен в Obsidian:
блок-схемы, последовательности, диаграммы — прямо текстом внутри md.

**Неизбежные сканы**
##- приехал подписанный бумажный акт:
JPEG для текста — худший выбор = артефакты + большой размер.
Берите **ч/б TIFF G4 или PNG**: A4 — 30–100 КБ, и читается идеально.

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

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

0

4

  • Автор: Avenir.Sirgun
  • Глава
  • Avenir.Sirgun
  • Откуда: Сверловская область
  • Зарегистрирован: Вс, 30 Янв 2011
  • Приглашений: 0
  • Сообщений: 1127
  • Уважение: [+14/-0]
  • Позитив: [+45/-2]
  • Пол: Мужской
  • Возраст: 57 [1969-05-29]
  • Провел на форуме:
    14 дней 6 часов
  • Последний визит:
    Вчера 07:18:10

##### Юридический контур — единственное, что нельзя пропустить
###### md **не может быть оригиналом**
подписанного документа.
Оригинал — бумага с подписью или документ с ЭП. Поэтому правило заморозки:

1. **Черновик и согласование**
md блестит: git-диффы правок, wiki-ссылки на условия,
никакой рассылки семи копий `договор_финал_ПОСЛЕДНИЙ(2).docx`.
2. **После подписания текст заморожен.**
Подписанный md перестаёт быть «живым» документом — любые изменения только новым документом
(доп. соглашение), никогда правкой файла.
Иначе «актуальный текст» в БД разойдётся с тем, что подписан на бумаге
и при споре это ударит по вам.
3. **Целостность**: `sha3-512sum` файла → в БД при регистрации.
Изменился файл без изменения истории — видно сразу.
Сильнее: GPG-подпись, и её armored-форма — *тоже текст*, вписывается в нашу парадигму.
4. **Исходящие контрагенту**:
PDF генерируется по требованию (`pandoc договор.md -o договор.pdf`) в момент отправки и
не хранится. Источник истины — md;
PDF — одноразовый артефакт сборки, как бинарник из исходников.

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

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

0

5

  • Автор: Avenir.Sirgun
  • Глава
  • Avenir.Sirgun
  • Откуда: Сверловская область
  • Зарегистрирован: Вс, 30 Янв 2011
  • Приглашений: 0
  • Сообщений: 1127
  • Уважение: [+14/-0]
  • Позитив: [+45/-2]
  • Пол: Мужской
  • Возраст: 57 [1969-05-29]
  • Провел на форуме:
    14 дней 6 часов
  • Последний визит:
    Вчера 07:18:10

Метаданные = ускорение работы с документами.

###### Именование файлов. сортировка по имени = хронология.
`YYYY-MM-DD_отправитель_краткая-тема.md` Сам документ со ссылкой на `YYYY-MM-DD_отправитель_краткая-тема.meta.md`
`YYYY-MM-DD_отправитель_краткая-тема.meta.md` - файл с метаданными и ссылкой на документ.

Метаданные указать в одноименном файле, тк иногда их может быть больше чем сам документ.
Для базы данных такие приёмы весьма полезны.

###### Метаданные для договора
Если нужен минимум — первые восемь строк
Тип, Номер, Дата, Вид, Статус, стороны с ИНН, роли
уже дают БД всё для поиска и фильтрации. Остальное — справочные детали.

```markdown
##- Тип: договор;
##- Номер: 2025-001;
##- Дата: 2025-01-15;
##- Вид: оказания услуг;
##- Статус: подписан;
##- Наша сторона: ООО «Пример»;
##- Наша роль: исполнитель;
##- Наш ИНН: 0000000000;
##- Контрагент: ИП Пв Пр Прч;
##- Контрагент тип: ИП;
##- Контрагент ИНН: 000000000000;
##- Предмет: разработка скрипта импорта метаданных;
##- Сумма: 150000;
##- Валюта: RUB;
##- НДС: не облагается;
##- Оплата: 50% аванс, 50% по акту;
##- Начало: 2025-01-20;
##- Окончание: 2025-06-30;
##- Подписан: 2025-01-17;
##- Подписант наш: Сидоров И.И., директор, Устав;
##- Подписант контрагент: Петров П.П., паспорт 45 00 №123456;
##- Оригинал: сейф, папка 2025/01;
##- Приложения: spec_2025-001.pdf;
##- Связанные: акт_2025-001, доп_соглашение_2025-001;
##- История: 2025-01-17 подписан;
```

##### Договорные
###### Акт
```markdown
##- Тип: акт;
##- Номер: АКТ-2025-001;
##- Дата: 2025-02-01;
##- Договор: 2025-001;
##- Период: 2025-01;
##- Сумма: 75000;
##- Валюта: RUB;
##- НДС: не облагается;
##- Статус: подписан;
##- Подписан: 2025-02-03;
##- Связанные: 2025-001;
##- История: 2025-02-03 подписан;
```

###### Доп. соглашение
```markdown
##- Тип: доп. соглашение;
##- Номер: ДС-2025-001;
##- Дата: 2025-03-01;
##- Договор: 2025-001;
##- Предмет: продление срока на 2 месяца;
##- Окончание новое: 2025-08-31;
##- Сумма итог: 150000;
##- Валюта: RUB;
##- Статус: подписан;
##- Подписан: 2025-03-02;
##- Связанные: 2025-001;
##- История: 2025-03-02 подписан;
```

###### Счёт
```markdown
##- Тип: счёт;
##- Номер: СЧ-2025-001;
##- Дата: 2025-01-18;
##- Договор: 2025-001;
##- Сумма: 75000;
##- Валюта: RUB;
##- НДС: не облагается;
##- Оплатить до: 2025-02-02;
##- Оплачен: 2025-01-25;
##- Статус: оплачен;
##- История: 2025-01-25 оплачен;
```

###### Спецификация
##- коммерческая, приложение к договору
```markdown
##- Тип: спецификация;
##- Номер: СП-2025-001;
##- Дата: 2025-01-15;
##- Договор: 2025-001;
##- Позиций: 12;
##- Сумма: 150000;
##- Валюта: RUB;
##- Статус: подписан;
##- Связанные: 2025-001;
##- История: 2025-01-17 подписан;
```

##### Технические
###### Чертёж
```markdown
##- Тип: чертёж;
##- Обозначение: АБВГ.301547.001;
##- Наименование: Кронштейн;
##- Изделие: Насос Н-01;
##- Проект: П-2025-003;
##- Формат: A3;
##- Масштаб: 1:1;
##- Листов: 1;
##- Стадия: Р;
##- Ревизия: 2;
##- Взамен: АБВГ.301547.001 рев.1;
##- Статус: действует;
##- Связанные: АБВГ.301547.002;
##- История: 2025-02-10 выпущена рев.2;
```

###### Принципиальная схема
```markdown
##- Тип: принципиальная схема;
##- Обозначение: АБВГ.301547.Э3;
##- Наименование: Схема электрическая принципиальная;
##- Изделие: Щит ЩС-2;
##- Проект: П-2025-003;
##- Формат: A2;
##- Стадия: Р;
##- Ревизия: 1;
##- Статус: действует;
##- История: 2025-02-12 рев.1;
```

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

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

0

6

  • Автор: Avenir.Sirgun
  • Глава
  • Avenir.Sirgun
  • Откуда: Сверловская область
  • Зарегистрирован: Вс, 30 Янв 2011
  • Приглашений: 0
  • Сообщений: 1127
  • Уважение: [+14/-0]
  • Позитив: [+45/-2]
  • Пол: Мужской
  • Возраст: 57 [1969-05-29]
  • Провел на форуме:
    14 дней 6 часов
  • Последний визит:
    Вчера 07:18:10

Эталон оформления ИНструкции или ТЗ
##- Имя файла: import_function_v01.md дата: 2026-09-07 07:00:28
##- Тип: Инструкция
##- Назначение: Импорт функций в баш скрипт;
##- Описание: Объявить функцию доступную другим скриптам;
##- Метаданные: import_function_v01.meta.md;

##### [[#Инструкция import_function_v01|Инструкция import_function_v01]]
###### [[#[01.] Sourced File;|[01.] Sourced File;]]
###### [[#[02.] Direct Call;|[02.] Direct Call;]]
###### [[#[03.] Дочернему Bash-процессу;|[03.] Дочернему Bash-процессу;]]
###### [[#[04.] return куда;|[04.] return куда;]]
###### [[#[05.] 555;|[05.] 555;]]
###### [[#[06.] 777;|[06.] 777;]]

##### Инструкция import_function_v01
Подключить функцию

###### [01.] Sourced File;
Вынесите функцию в отдельный файл
```bash
#!/usr/bin/env bash
##- main-script.sh
##- Подключаем функцию
source "$(dirname "$0")/functions.sh"
##- или: ."$(dirname "$0")/functions.sh"
hello "мир"
```
..functions.sh
```bash
##- function.sh с эхом
##- For Source Call
##- Сама функция в отдельном файле
hello() {
    echo "Привет, $1"
}
```

..functions.sh
```bash
##- function.sh , передать строковое значение
##- For Source Call
##- Сама функция в отдельном файле
console_type() {
    CONSOLE_TYPE="$1"
}
```

###### [02.] Direct Call;

```bash
#!/usr/bin/env bash
##- main-script.sh
##-файл запускается напрямую
."$(dirname "$0")/functions.sh"
##- ИЛИ
./functions.sh
```
..functions.sh
```bash
#!/usr/bin/env bash
##- function.sh
##- For Direct Call
##- Сама функция в отдельном файле
hello() {
    echo "Привет, $1"
}
```
###### Ссылка на [[#Инструкция import_function_v01:|Инструкция import_function_v01]]

###### [03.] Дочернему Bash-процессу;
```bash
#!/usr/bin/env bash
##- function.sh
##- передать функцию именно дочернему Bash-процессу
hello() {
    echo "Привет"
}
export -f hello
bash main-script.sh
```

```bash
#!/usr/bin/env bash
##- main-script.sh
##- Вызов функцию
hello
```

###### [04.] return куда;
```bash
##- return ставится после вычисления И возвращает только код завершения
console_type() {
    if [[ "$TERM" == *256color* ]]; then
        CONSOLE_TYPE="256"
        return 0
    else
        CONSOLE_TYPE=" обычный"
        return 1
    fi
}

```
###### Ссылка на [[#Инструкция import_function_v01:|Инструкция import_function_v01]]

###### [05.] 555;
```bash
#!/usr/bin/env bash
##-

```
###### [06.] 777;
```bash
#!/usr/bin/env bash
##-

```
###### Ссылка на [[#Инструкция import_function_v01:|Инструкция import_function_v01]]

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

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

0

7

  • Автор: Avenir.Sirgun
  • Глава
  • Avenir.Sirgun
  • Откуда: Сверловская область
  • Зарегистрирован: Вс, 30 Янв 2011
  • Приглашений: 0
  • Сообщений: 1127
  • Уважение: [+14/-0]
  • Позитив: [+45/-2]
  • Пол: Мужской
  • Возраст: 57 [1969-05-29]
  • Провел на форуме:
    14 дней 6 часов
  • Последний визит:
    Вчера 07:18:10

2026-09-02 Для документов.
Переходим на разметку markdown,
чтобы отказаться от использования офисных пакетов.
##- метаданные документа в формате комментарии маркдаун, совместимый  c bash,
##### уровень заголовка 5, иначе буквы гигантские.
###### уровень подзаголовка 6, иначе буквы гигантские.
Длина строки до 90 символов,.

Вот новый шаблон оформления,
Шаблоны метаданных приведены в сообщенииях выше, примените подходящий,
добавьте стандартную шапку для деловой переписки после метаданных,
метаданные отмечены "##- " в начале документа.
замените буквы и числа на актуальные:
##- Имя: Имя_файла_версия.md
##- Дата: yyyy-mm-dd_чч:мм.
##- Тема: Наставничество закон и мнения
##- Метаданные: Имя_файла_версия.meta.md
##### Содержание:
###### [[#[01.] Роструд разъяснения|[01.] Роструд разъяснения]]
###### [[#[01.1] Определение "Наставничество"|[01.1] Определение "Наставничество"]]
###### [[#[01.2] О регулировании нормами ТК|[01.2] О регулировании нормами ТК]]
###### [[#[01.3] Мнение Онлайнинспекции|[01.3] Мнение Онлайнинспекции]]
###### [[#[01.4] Обязанности и поручение|[01.4] Обязанности и поручение]]
###### [[#[01.5] Достаточность доп соглашения|[01.5] Достаточность доп соглашения]]
###### [[#[01.6] Виды доплат|[01.6] Виды доплат]]
###### [[#[01.7] Как отказаться|[01.7] Как отказаться]]
###### [[#[01.8] Размеры и условия оплаты|[01.8] Размеры и условия оплаты]]
###### [[#[01.9] Ссылки на мнения|[01.9] Ссылки на мнения]]
###### [[#[01.11] Рекомендую пиШушим законы учебники|[01.11] Рекомендую пиШушим законы учебники]]

Исходный материал взят
https://pikabu.ru/story/rostrud_o_nasta … e_12719723
И переработан лично мной без ИИ для лаконичности и логичности.
Лицензия свободная, ссылка при упоминаниях обязательна, отсутствие любых гарантий.
Опубликовано мной https://pikabu.ru/story/nastavnichesvto … a_14288910

Наставничество: с 1 марта вступила в силу статья 351.8 ТК РФ.
##### [01.] Роструд разъяснения
###### [01.1] Определение "Наставничество"
Согласно ст. 351.8 ТК РФ наставничество в сфере труда - это выполнение работником на
основании его письменного согласия по поручению работодателя работы по оказанию другому
работнику помощи в овладении навыками работы на производстве и (или) рабочем месте по
полученной (получаемой) другим работником профессии (специальности).
###### [01.2] О регулировании нормами ТК
В  351.8 ТК РФ нет  об регулировании положениями ТК о наставничестве.
###### [01.3] Мнение "Онлайнинспекция.РФ"
если наставничество включено в должностные обязанности работника, то такая работа не
подлежит дополнительной оплате и работник не может отказаться от нее в одностороннем
порядке, как это предусмотрено ст. 351.8 ТК РФ.
###### [01.4] Обязанности и поручение
Разница между обязанностями и поручением.
если работа поручается на определенный срок - то наставничество.
если в трудовом договоре никаких сроков выполнения такой работы не оговорено,
то это не наставничество.
"Онлайнинспекция.РФ"
###### Ссылка на [[#Содержание:|Содержание]]

###### [01.5] Достаточность доп соглашения
нужен ли приказ - нет, хватает только доп соглашения к трудовому договору
###### [01.6] Виды доплат
Стимулирующим или компенсационные?.
компенсационные выплаты не включаются в состав заработной платы для
целей ее сравнения с МРОТ, а стимулирующие - включаются.
###### [01.7] Как отказаться
ч. 6 ст. 351.8 ТК РФ работник имеет право досрочно отказаться от осуществления им
наставничества, а работодатель - досрочно отменить
поручение об осуществлении наставничества,
предупредив об этом работника не менее чем за три рабочих дня.
###### [01.8] Размеры и условия оплаты
Должны устанавливаться колдоговорами и ЛНА. И если отсутствуют , то является нарушением.
###### [01.9] Ссылки на мнения.
[раз]("https://онлайнинспекция.рф/questions/view/218250"),
[два]("https://онлайнинспекция.рф/questions/view/219705"),
[три]("https://онлайнинспекция.рф/questions/view/219435"),
[четыре]("https://онлайнинспекция.рф/questions/view/217944"),
[пять]("https://онлайнинспекция.рф/questions/view/218538"),
[шесть](--).
###### Ссылка на [[#Содержание:|Содержание]]

###### [01.11] Рекомендую пишушим законы и учебники
    Логика и искусство краткого и точного выражения мыслей.
Ато совсем низко пали, - вашу пургу сложно понимать даже носителю русского языка с рождения.

* «Законодательная техника» (Д. А. Керимов) —
классическое пособие по логике, языку и четкой структуре законов.
* «Язык закона» (под ред. А. С. Пиголкина) —
фундаментальный труд о краткости, ясности и точности юридических формулировок.
* «Юридическая техника» (Т. В. Кашанина) —
практический учебник по конструированию нормативных актов без двусмысленности.

###### Ссылка на [[#Содержание:|Содержание]]

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

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

0

Страница: 1

Вы здесь » Портал » Документация » Требования оформления документации v6