Рубрика «документация» - 2

Доброго времени суток!

Для начала представлюсь: я бэкенд-разработчик с опытом более 8 лет. Участвовал в разнообразных проектах: в стартапах, в галерах, в крупных корпорациях и в среднем бизнесе. К сожалению, найти идеальную статистику по данной теме не представляется возможным, однако из общения с бывшими коллегами я понимаю, что то, что будет описано ниже, — не только мой личный опыт, но и то, что регулярно происходит в других компаниях.

Читать полностью »

Друзья, привет! Меня зовут Ларионов Александр. Я работаю системным аналитиком. Совместно с Лабораторией инноваций Московской биржи мы изучали вопрос применения AI в системном анализе.

Читать полностью »

Ну хорошо, не поразило. Но понравилось настолько, что я записала это в свой блокнот, а теперь, спустя 13 лет, делюсь с вами. Если вы работаете с документацией, интерфейсами или пишете ТЗ или bug reports, эти заметки будут вам полезны. Кстати, вот первая часть статьи - взгляните, если пропустили.

Читать полностью »
Обложка: гибридная система заметок в Obsidian

Обложка: гибридная система заметок в Obsidian

Читать полностью »

В первой части (eсли не читали — вот она) я говорила о том, как быстро изучить проект, получить доступы и изучить документацию. Теперь переходим к следующему этапу — организации тестирования.

Порой всего просто слишком много и это вызывает хаос, в котором из вида теряются важные детали и появляется прокрастинация. Такие ситуации часто вызывают стресс и для того, чтобы этого избежать (или свести к минимуму) нужен план и понимание что, а главное для чего, нужно делать.

Читать полностью »

Меня зовут Саша, я технический писатель в команде документации Yandex Cloud. В свободное от работы время я занимаюсь другой работой — изучаю инструменты для документирования и экспериментирую с ними. Один из моих экспериментов был посвящен изучению и внедрению спеллчекера CSpell в мои процессы создания документации.

Статья будет полезна всем, кто хочет научиться проверять тексты в исходных файлах, будь то Markdown, YAML или комментарии в коде. Больше всего пользы из нее вынесут технические писатели и те, кто формирует процессы для команд технических писателей.

Читать полностью »

«Клюква» — автоматизация документации проектов на Python - 1

Привет!

Меня зовут Алексей Фоменко.

Я разработчик из Нижнего Новгорода.

Сегодня хочу рассказать вам о своем сервисе "Клюква".

Почему "Клюква" и "автоматизация документации"?

Ответ на самом деле простой — потому что мне это название нравится.

Читать полностью »

Всем привет! Меня зовут Севара Ахтямова и я работаю техническим писателем — аналитиком около 4 лет. В этой статье я расскажу, как AI помог мне справиться с рабочей рутиной — от генерации toctree до отладки сборки Sphinx-документации. Всё это — на реальных задачах. Я постаралась собрать побольше примеров из личного опыта. Надеюсь, не слишком много.

Читать полностью »

Любой инженер, сталкивавшийся с инцидентами в ИТ-системах, знает: решение часто есть в документации. Проблема в том, что найти его — как искать иголку в стоге сена. Документация объёмная, разрозненная, специфичная и написана далеко не всегда для людей. Время идёт, SLA поджимает.

Но что если бы у нас был помощник, который мгновенно читал бы всю документацию, понимал бы контекст сбоя и предлагал конкретные рекомендации? Сегодня это возможно — благодаря большим языковым моделям (LLM), таким как GPT-4, Claude, Gemini и другим.

Читать полностью »


https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js