Очень классный шаблон описания понятия подсмотрен тут Личная база знаний: понятийная база ConceptBase — Анна Лубенченко на TenChat.ru. Хорошие советы как выделять понятия и что важно для составления онтологии, чтобы этим могли пользоваться не только составители.
шаблон:
- название
- описание(своими словами)
- критерий проверки (например через месяц открыли статью о понятии и понял о чем речь, смог быстро привести пример и ловушку)
- примеры и ловушки
- пример (заземление на физический мир)
- ловушка которая точно не подходит (заземление на физический мир)
- источники информации
Пробую применить этот шаблон для роли разработчик ПО в определенной организации Н.
| понятие | описание | пример | ловушка |
|---|---|---|---|
| репозиторий | место хранения кода | github | архив документов МГУ |
| CI-цикл | события и процессы происходящие между пушем кода в отдельную ветку и положительным/отрицательным вердиктом системы о качестве кода | тесты(unit + integration) + ревью кода | проверка мерж конфликтов |
| логи | записанная последовательность событий произошедшая с конкретным приложением/сервисом/нодой | кластер elasticsearch с логами наших сервисов | огненный великан из |
| IDE | интегрированная среда разработки: редактор кода, дебаггер, консоль, всякие плагины для упрощения и т.д. | - Emacs - IntelliJ IDEA - VSCode |
- блокнот - make - GDB |
| трекер задач | софт в котором мы заводим задачи с подробным описанием, оценкой, приоритетом и т.д. | JIRA | - email - список хотелок продакта в чате |
С одной стороны кажется смешно и наивно, что такие мелочи нужно прописывать и так и казалось вначале. Но когда расписал и подумал - вспомнил что вообще-то было несколько случаев когда такого списка не хватало:
- онбоардинг новых людей
- какие-то ссылки быстрого доступа(почему-то и недели не проходит без того, чтобы кто-то не спросил ссылку на эластик)
- дополнительное усилие на внимание(например трекер задач, почему-то до сих пор фраза “я создал задачу” иногда означает абсолютно неструктурированное нечто скинутое в чате)
