Долой бумажную волокиту! Ученые ПНИПУ разработали программу для написания технической документации
Большинство работников регулярно сталкивается с рутинной, но очень нужной работой с документами. На написание технических заданий, отчетов и прочих проектов со множеством формальных правил тратится большое количество человеческих и временных ресурсов. Ученые Пермского Политеха разработали интеллектуальную систему помощи «Техдок менеджер», которая быстро и точно создает документацию по заданным правилам за секунды. Современные нейросети не умеют следовать четким стандартам, таким как ГОСТ, результаты их работы требуют тщательной проверки в отличие от программы политехников. Она поможет исключить фактор человеческой ошибки, ускорить работу и автоматизировать шаблонные процессы.
На разработку выдано свидетельство №2024612000.
Для написания технической документации компании чаще всего нанимают отдельных специалистов – технических писателей. Они разрабатывают инструкции по эксплуатации, руководства пользователя, отчеты и другие материалы, которые помогают понять и использовать различные продукты, технологии или услуги. Еще такие люди пишут документы технической спецификации, больше ориентированные на разработчиков или отчетность. Помимо самого написания требуется соблюдать определенные правила и ГОСТы.
Но не только технические писатели сталкиваются с подобной задачей. В обязанности многих сотрудников входит ведение документации, особенно в государственных организациях. Например, преподаватели в своей практике часто встречаются с необходимостью формирования целого перечня документов: рабочая программа дисциплины, методические указания к лабораторным и практическим работам, фонд оценочных средств.
Ученые Пермского Политеха разработали программу для компьютеров «Техдок менеджер» – это интеллектуальная система помощи техническому писателю. Программа помогает избежать человеческих ошибок (что-то пропустить или перепутать), «интеллектуально» отслеживает даты, термины и прочее. Автоматизирует рутинные процессы и ускоряет документооборот. «Техдок менеджер» может сам следить за выполнением плана работ над проектом без внесения дополнительных данных. «Помощник» легко модифицируется и настраивается под различные задачи и создает множество альтернативных решений.
Логика разработанной программы построена на классификации и кластеризации текстов различной длины, поиске и распознавании сущностей (конкретные объекты или понятия, которые имеют уникальное имя и могут быть идентифицированы в тексте, например, имена людей, названия организаций, даты и т.д.). «Техдок менеджер» извлекает и систематизирует факты из текста, собирает данные для обработки и понимания естественного языка. Он выявляет содержательные, логические и фактические ошибки, а еще распознает литературные приемы и стили. В итоге синтезирует человеко-читаемый текст на основе выявленной ранее информации и запросов пользователей.
– Ключевая задача нашей программы в том, чтобы одни документы или их части, содержательно зависимые от других, заполнить автоматически. Например, из техзадания органично вытекает технический проект. Его большую часть можно автоматически составить как заготовку документа, но человек должен внести правки. От них уже зависит, например, содержание таких частей как «Введение», «Заключение» и «Список использованных источников». Их можно отредактировать автоматически, – поделился кандидат технических наук, доцент кафедры информационных технологий и автоматизированных систем Даниил Курушин.
Средств автоматизации разработки документации достаточно много, но они чаще всего ориентированы на решение других проблем. Например, современные нейросети способны выполнять рерайтинг и синтез текста, однако результат их работы требует проверки, поскольку они не созданы для работы по стандартам ГОСТ. Разработка ученых ПНИПУ отличается тем, что использует синтез нейронных сетей и специального метода моделирования данных.
– «Помощник техническому писателю» формируется как интерфейс к разрабатываемым нами микропрограммам, скриптам, автоматизирующим работу специалиста. Сначала возникло понимание, что, например, вопросы к курсу лекций можно не сочинять, а написать программу, которая сгенерирует их вместе с вариантами правильных и неправильных ответов. Разумеется, планируется использовать и современные языковые модели, такие как GPT и другие генеративные сети. Также предполагается работа по автоматизированному составлению словарей и справочников, – рассказывает Даниил Курушин.
Программа будет реализована в виде веб-приложения (сайта). Для создания готового текста пользователю необходимо выбрать стандарт, этап и тип документа, который необходимо сформировать, а также написать в окно чата запрос с уточняющими деталями.
«Техдок менеджер» поможет избавиться от рутинной работы. Сейчас ученые Пермского Политеха сами пользуются программой, а в течение года обещают выпустить полноценный продукт для пользователя. Помощника можно будет применять в сфере образования, при разработке продуктов и для сопровождения программного обеспечения.
Онбординг для программиста
Всем привет, работаю java разработчиком 10 лет, хотел бы рассказать как обычно происходит введение в должность нового сотрудника, aka онбординг.
Вы получили пропуск, технику, пароль от учетки, познакомились с командой проекта. Один из команды становится ответственным за то чтобы направить вас на начальных этапах, он называется buddy.
В идеальном случае есть документация для нового сотрудника - как получать доступы, как деплоить и смотреть логи и прочие необходимые вещи. Скоре всего инструкции или будут отсутствовать (в маленькой компании) или будут не полностью актуальны (в большой).
Нужно чтобы вас добавили в общие чаты, общие емейлы и встречи команды. Тут же могут подсказать чат с мемами, чат обеда и прочие места интересов.
Требуется ознакомиться также с административными системами - таск трекер, учет времени, hr системы.
Дальше вам должны дать задачу по разработке, в идеальном случае это должен быть очевидный фикс, который позволит отработать внесение изменений, согласование пулл реквеста, деплой на тестовый стенд, передачу в тестирование и прочие шаги.
Далее сложность задач будет идти по нарастающей, и buddy будет участвовать всё меньше.
Если документации по онбордингу нет, то к вам часто будут обращаться новички с повторяющимися вопросами. Мне кажется лучшим вариантом записывать эти вопросы как пункты документации, а ответы на них чтобы записывали сами новые сотрудники. За несколько итераций можно покрыть большинство общих тем.
Отдельно выделю важность документации по предоставлению доступов. После увольнения сотрудника желательно "прибрать" за ним, пройдя по списку доступов и деактивировав их.
Всем удачных трудоустройств!
Excalidraw — сервис для рисования диаграмм
На днях узнал о классном сервисе для рисования диаграмм:
В бесплатной версии можно работать лишь на одном холсте, но его можно сохранить локально и таким образом работать над несколькими диаграммами
Доступные разные стили оформления текста, мне очень нравится рукописный
Можно использовать сторонние библиотеки компонентов, например, чтобы рисовать UML диаграммы
Я и есть документация
Джун - Где документация?
Тимлид - Я и есть документация
Мышление письмом
Сам того не подозревая в прошлом году я начал практиковать мышление письмом. Я перестал сразу бросаться писать код, вместо этого, в начале я записываю свои мысли и обдумываю задачу. Во время решения сложных задач я выписываю все свои мысли, а при реализации большой фичи стараюсь составить план и описать принцип её работы. Всё это очень упрощает реализацию.
Зачем?
- По закону Миллера мы не можем держать в голове более 7-ми элементов
- Задача нашего мозга — генерация идей, а не запоминание. Лучше записывать идеи и обдумывать их пока они не ускользнули от вас
Примеры применения:
- Если вы описываете свои мысли, то вы сможете проще писать документацию в проектах. Ведь большая часть уже готова — необходимо лишь немного причесать
- При решении задачи, просто накидывайте все идеи и начинайте их письменно продумывать. Если всё это делать в голове — вам мозг просто закипит и вы забудете почему те или иные варианты плохи, а какие хороши
- В дальнейшем вы сможете обосновать почему вы приняли то или иное решение
- Ведение проектов в Notion — мышление письмом, ведь при создании проекта всё записывается в систему. Не нужно запоминать план действий — он зафиксирован, вы его не забудете
- Ведение блога — тоже мышление письмом. Ведь при написании поста вы записываете все свои мысли, а в дальнейшем сможете к ним вернуться.
Статья также расскажет, как данный подход:
- Может улучшить психологическое состояние
- Используется в Amazon
- Используется для исследовательских задач
О документации
Разработчики: Документация должна быть понятной, по делу и в официальном стиле
Так же разработчики:
Официальная документация по ядру linux.
P.S. перевод:
Внимание
Наименование «tasklet» вводит в заблуждение: оно не имеет ничего общего с «tasks», скорее всего оно связано с плохой водкой, которую в то время выпил Алексей Кузнецов(один из мэйнтейнеров ядра linux).