Files
Wallenc/Report/puml/README.md

35 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Диаграммы PlantUML для ПЗ
## Что требует ГОСТ 7.32 (и чек-лист)
| Пункт | Требование |
|-------|------------|
| 6.5.2 | Чертежи, схемы, диаграммы — по **ЕСКД**; для блок-схем ПО — **ГОСТ 19.701-90** (аналог ISO 5807) |
| 6.5.3 | Без «объёмных» рисунков, только по делу |
| 6.5.7 | Подпись **в Typst**: «Рисунок N Наименование» (среднее тире), не внутри PNG |
| 6.5.8 | Наименование с прописной буквы, без точки в конце |
**ГОСТ 19.701-90 (кратко):** процесс — прямоугольник; решение — ромб; начало/конец — овал; линии — сплошные со стрелками; ч/б контуры; без декоративной заливки.
## Оформление в репозитории
- `plantuml-gost.cfg` — ч/б, прямоугольные блоки activity, шрифт с засечками, без тени (подключается в `render_puml.sh`).
- `_gost-theme.inc.puml` — напоминание не дублировать `title` в `.puml`.
- `scripts/normalize_puml_gost.py` — перед рендером убирает локальные `skinparam`/`title`, добавляет `!include _gost-theme.inc.puml`.
Подписи к рисункам задаются только в `includes/*.typ` через `pz-fig(...)`.
## Сборка
```bash
cd Report/scripts
./render_puml.sh
```
PNG: `Report/images/fig_*.png`.
## Ограничения PlantUML
- **BPMN**, **CJM**, **DFD** в `.puml` — упрощённые схемы; строгий ГОСТ 19.702 (схемы данных) или ЕСКД 2.x вручную в Visio/draw.io при необходимости нормоконтроля.
- Ввод/вывод (параллелограмм по ГОСТ) в activity-диаграмме PlantUML не выводится автоматически — для I/O используются обычные блоки процесса.