Обновить

Как техпису общаться с командой разработки на одном языке (нотаций), или Учимся приручать лису

Уровень сложностиПростой
Время на прочтение11 мин
Охват и читатели6.7K
Всего голосов 9: ↑8 и ↓1+13
Комментарии13

Комментарии 13

В качестве подсказки я сделала схему, некую модель знаний. Я не пользовалась никакими нотациями и следовала лишь своей интуиции.

Напоминает интеллект-карту — кстати, ещё один вид графической нотации. Спасибо, полезная схема.

Как раз хотел добавить, что у PlantUML помимо описанных в статье прекрасных типов диаграмм есть довольно приятный на вид mindmap: https://plantuml.com/ru/mindmap-diagram

С небольшой стилизацией выглядит вообще волшебно. И писать просто - как многоуровневый список.

А так - диаграммы классов, последовательности и активности - самый топ.

Когда схемы большие, начинается шаманство с размещением элементов для повышения удобочитаемости, но это отдельная история.

Большое спасибо, я очень рада, что нашли полезное :) Полностью согласна про большие схемы

некую модель знаний. Я не пользовалась никакими нотациями и следовала лишь своей интуиции.

Примерно так этот весь UML и используется. (осторожно, там PDF на 796 страниц и 18 МиБ)

Изучать что бы то ни было по спецификации — удел искусственного интеллекта. Как к справочнику по конкретному спорному моменту к ней можно обратиться, но не более.

А что, текущие LLM выдадут рабочий и robust парсер по твёрдозаданной спеке? Абстрактнее и формализованней задачи не придумаю, где бы еще каждый символ на счету был.

На данном этапе видно, что строгое формальное моделирование комьютерных программ/систем оказалось где-то в прошлом, в 80-90 гг. А UML как раз про это. Типа вот тут визуализированная спецификация, по которой можно сгенерировать полноценный программный код.

Что касается моего исходного посыла, то astenix ниже попал в яблочко.

Я фанат UML.

После изучения UML я понял, что только фанаты UML разбираются в ромбиках и овалах, и помнят, чем они отличаются. Все остальные видят в этих диаграммах заявление типа «Эй, смотрите, я разбираюсь в UML! А вы нет…»

Чем проще диаграммы, тем лучше. Вообще идеально смотрятся узлы без рамки, и GraphViz их делает безупречно.

Чем меньше диаграммы, тем лучше. Если получается монстр, его надо разбить на отдельные маленькие.

Всë.

И правда 😁

Есть же аналитики, лучше через них

Это да :) Но иногда их нет. Иногда техническому писателю нужно совмещать в себе и роль аналитика. А так - да, сто процентов

Иногда спорят: Архитектор \ архитектура (вкл. архитектура процессов \ процессники) – это не про «квадратики и стрелочки».

Однако тогда это будут «глухонемые архитекторы» (процессники, техписы и т.п.). Чтобы выразить смысл нужны именно «квадратики и стрелочки» и их «качество» - как визуальная выразительность (важная составляющая). Однако первый элемент «качества» – это онтологическая (смысловая, семантическая) составляющая, но про нее мало говорят.  

Конечно, можно обойтись только языком RDF (язык формализации знаний) и его визуальным представление (RDF grapher), но тогда у архитектора и команды должен быть опыт работы с Linked Data и это конечно не «народный метод» (сложный, непрактичный). Поэтому технологический путь:

1 смысл / мысль (неформализованное представление чего-либо в «черепной коробке»), т.е. что-то вначале нужно осмыслить (и потом уже формализовать);

2 строгая формализация смысла на языке знаний (хотя бы метамодель типа togaf\ archimate), т.е. семантическая обертка смысла / мысли (через онтологию и язык знаний), это выделение и идентификация объектов (справочник типов объектов и предикатов, т.е. метамодель) ;  

3 графическая нотация – как интерпретация объектов метамодели в «квадратики и стрелочки» (хотя бы нотация togaf\ archimate).

Подробнее обсуждали на днях тут (Текстовый редактор моделей) и тут (Дракон).

Ключевая проблема – это семантика – как упаковать смысл в знания (строгий формализм утверждения на языке знаний, не обязательно графическом) и потом уже его переупаковка - синтаксическая обертка - в «квадратики и стрелочки» из togaf\ archimate, VAD\EPC, UML\ERD …

Обычно техписы «перепрыгивают» с первой ступени на третью, но это в ущерб качеству. Есть «два мира»: семантика и синтаксис (графическая грамматика) – и они разные. Семантика сегодня скорее напоминает подводную часть айсберга: большая, но скрытая.

Какие знания о нотациях точно пригодятся техническому писателю

В перечислении (в статье) только нотации синтаксиса (синтаксические «обертки» смысла), а про семантические – нет упоминаний.

Подскажите, пожалуйста, можете порекомендовать какой-нибудь кур по UML ?

Ох, прям курс, наверное, я порекомендовать не могу. Мне лично помогли разного рода статейки про UML и про проектирование системы в целом. Но, возможно, у кого-то из коллег есть хорошие рекомендации курса. Самой было бы интересно :)

Зарегистрируйтесь на Хабре, чтобы оставить комментарий

Информация

Сайт
www.sber.ru
Дата регистрации
Дата основания
Численность
свыше 10 000 человек
Местоположение
Россия