Архив рубрики ‘документация проекта’

Когда онбординг длится 2 месяца — День 1: Убрать хаос

Итак, вы нашли своего идеального кандидата. Возможно, он даже очень силён, но спустя 2 месяца всё ещё не вышел на ожидаемую продуктивность. Более того, вы заметили, что производительность команды только снизилась, потому что другие инженеры тратят время на онбординг нового человека. Наверное, я не открою Америку, если скажу, что это довольно тревожный сигнал.

Нужен ли синопсис технической документации? Личный опыт разработки

Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт, сложно будет искать и исправлять ошибки и проводить необходимые доработки, когда в них возникнет необходимость, и т.д.

Где вести базу знаний: 8 российских сервисов и их возможности

Когда в команде больше 5 человек, ссылка на папку с документами перестает работать. Ну, или как минимум становится просто неэффективной. Файлы дублируются, версии путаются, половина инструкций устаревает. Поэтому мне захотелось посмотреть и разобрать российские сервисы для базы знаний — с ценами, ограничениями и честными плюсами/минусами. Подробнее о них — в статье ниже. Что такое база […]

Генеральная уборка базы знаний: плюсы, подводные камни, минусов не будет

Привет, Хабр. Меня зовут Мария Рылик, я — старший контент-менеджер группы управления пользовательским опытом веб-поддержки «Лаборатории Касперского». И полтора года назад я столкнулась с распространенной в техписовских кругах проблемой: децентрализованной базой знаний. Чтобы найти инфу по работе с конкретным продуктом, приходилось по крупицам искать ее в разных статьях, в большинстве своем имеющих мало общего с […]

Размышления о документации

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

Секреты передачи знания: переход границ опыта при уходе ключевых инженеров и документирование архива проектов

Каждый разработчик рано или поздно сталкивается с ситуацией: из команды уходит «тот самый» человек, который держал в голове половину архитектуры. Вместе с ним уходит не только опыт, но и часть будущего проекта. В статье делюсь мыслями и подходами, как минимизировать потери при передаче знаний, какие форматы работают, а какие — нет, и почему документация должна […]

TDMS Фарватер Web: смотрите онлайн-премьеру 30 сентября

Приглашаем на премьеру TDMS Фарватер Web – новой системы с удобным веб-интерфейсом для документооборота и управления проектированием в строительстве. Изображение

Безумству храбрых… Как заставить ИИ понимать нормативные требования для проверки ЦИМ

Сгенерировано AI Прошло целых два года, как команда NSR Specification твердо пообещала добиться автоматизации экспертизы цифровых информационных моделей

Разработка требований к ПО с помощью Markdown, Git и Obsidian

Привет из ада трассировки требований В предыдущей статье автор сформулировал набор принципов организации хранения и оформления документации ПО, позволяющих преодолеть пропасть между требованиями верхнего уровня (ТВУ) бизнеса к программному продукту и требованиями нижнего уровня (ТНУ) к программному коду, а именно: Каждое требование записывается в отдельный файл в формате Markdown.

Как применять чат-ботов с LLM для решения простых офисных задач

Предисловие Добрый день, уважаемые читатели! Не так давно я проводил внутрикорпоративное мероприятие о том, как правильно применять чат-ботов, чтобы немного ускорить офисную рутину. Мероприятие очень понравилось аудитории, поэтому я решил переработать презентационный материал в статью — вдруг он принесет пользу еще кому-нибудь?

12