Мы продолжаем серию публикаций о том, как искусственный интеллект меняет работу программистов и людей в целом. После глобальных размышлений о будущем общества предлагаем вернуться к земным задачам и обсудить, как ИИ помогает избежать одного из самых ненавистных для разработчиков процессов – написания документации.
Оказалось, нейросети могут быть не только собеседниками в полуночных философских беседах, но и неплохими техническими писателями. В Nextner мы научили ИИ писать статьи для базы знаний, и теперь он берет на себя эту рутинную работу, освобождая нам время для действительно важных задач. Как мы к этому пришли? Давайте разбираться.
Для чего вообще нужна база знаний?
Каждый проект, даже даже самый простой, требует руководства по использованию. Без этого вас ждет бесконечный поток вопросов от клиентов и новых членов команды: "Как обновить контент?", "Где настройки модуля?", "Почему тут ошибка?".
Писать инструкции под каждый проект вручную слишком скучно и времязатратно, и мы решили попробовать делегировать эту задачу ИИ. Взяли готовые технические задания, которые писали для разработчиков, и скормили их нейросетям. На выходе получили документ, который объясняет, как работает тот или иной функционал. Процесс выглядел довольно просто: техническое задание + промт для ИИ = готовая статья.
DeepSeek и Gemini оказались умнее собратьев – они понимали, чего мы хотим, и выдавали внятные инструкции. ChatGPT в этом плане подводил: слишком много фантазировал и требовал серьезных правок.
И кто все это читает?
Полученные статьи мы используем в трех направлениях:
- Для клиентов – особенно тех, кто самостоятельно поддерживает свои проекты. Вместо бесконечных объяснений по телефону теперь мы просто отправляем ссылку на соответствующую статью в базе знаний.
- Для подрядчиков – некоторые проекты поддерживаются другими командами, например, девопсерами. Важно, чтобы они могли быстро ознакомиться с документацией и понять, как работает тот или иной функционал.
- Для себя – когда через полгода возвращаешься к проекту и понимаешь, что совершенно не помнишь, как все устроено, готовая документация экономит массу времени и нервов.
Но есть важный нюанс: чтобы полученный результат действительно приносил пользу, нужны качественные технические задания. Как составить такие ТЗ – это отдельная тема, которой мы обязательно уделим внимание в следующих публикациях.
Минута вместо часа: магия автоматизации
Главный плюс нашего подхода – экономия времени. Если раньше на создание одной статьи для базы знаний уходило около часа, то теперь – буквально минута (ну ладно, с проверкой – три). Это значит, что разработчики меньше отвлекаются на объяснения и могут сосредоточиться на действительно важных задачах. А это улучшает производительность, а значит, позволяет нам предлагать услуги по более низким ценам, сохраняя при этом высокую маржинальность.
Конечно, ИИ не идеален: сложную логику понимает плохо, а про неочевидные решения в коде и вовсе молчит. Поэтому мы всегда проверяем получившиеся материалы и при необходимости дополняем вручную. Но даже с учетом доработок этот метод оказался настолько эффективным, что мы уже не представляем, как обходились без него. Теперь, когда новый сотрудник присоединяется к проекту, ему не нужно по три дня разбираться в коде – достаточно открыть базу знаний.
Если вы до сих пор пишете документацию вручную, попробуйте наш способ. Возможно, он избавит вас от головной боли. Главное – не забывать, что ИИ пока не заменяет человека, а лишь помогает ему тратить меньше времени на рутину. И с этим он справляется на твердую четверку.
Изображения от Freepik.