Подготовка технической документации *

Сколько людей - столько и мнений о процессах в команде (с). 

Давайте поразмышляем - как выстроить процесс анализа так, чтобы он стал для команды не формальным набором этапов, а рабочим инструментом? Опираемся на наш опыт работы в командах разработки одного из операторов электронного документооборота.  Все описанные процессы формировались и развивались на практике.

За отправную точку возьмем несколько потребностей: 

• управлять неопределённостью,

• повышать качество требований,

• снижать риски на этапе разработки. 

Поделимся опытом работы в команде разработки продукта электронного документооборота. 

Расскажем о своих решениях, ошибках, находках, и компромиссах и о рабочей модели, которой мы сейчас придерживаемся.

Каждый день через системы «Честного знака» проходят тысячи страниц: контракты, акты, техдокументация, анкеты. Всё это нужно не просто перевести в текст — а сразу пустить в работу: поиск, анализ, генерация выжимок, передача в другие сервисы. Одна ошибка OCR — и вместо «субподрядчика» система получает «cy6пoдpялчика», а дальше никакие регулярки не спасут.

Меня зовут Искандер, я - AI-инженер в Лаборатории искусственного интеллекта «Честного знака». Мы протестировали лучшие open-source OCR-движки на реальных русскоязычных документах — от простых текстов до многостраничных PDF со сложными таблицами и изображениями. Специфика задачи: кириллица, широкий разброс форматов, нулевая терпимость к ошибкам на продакшне.

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

Привет, Хабр и коллеги-техписы! Я Оля Исхакова, работаю техническим писателем в Т-Банке. Мы с командой занимаемся развитием документации для внутренних продуктов, пишем коммуникации, анализируем пользовательский путь и предлагаем идеи по улучшению интерфейсов. 

Расскажу историю о том, как мы доказали на цифрах, что документация приносит пользу бизнесу.

В рамках данной статьи рассказываю об очередных нововведениях в законодательстве о персональных данных.

С 30 мая 2025 вступил в силу Федеральный закон от 30.11.2024 № 420-ФЗ «О внесении изменений в КоАП РФ», пунктом 10 которого установлена ответственность за невыполнение или несвоевременное выполнение оператором персональных данных обязанности по уведомлению уполномоченного органа по защите прав субъектов персональных данных о намерении осуществлять обработку персональных данных.

А теперь перевожу с юридического на человеческий все важные нюансы указанного нововведения ↓

Уважаемый читатель, хочу поделиться опытом преподавания 10-пальцевой печати в ВУЗе.

Сначала расскажу, как я к этому пришёл. Семь лет назад меня попросили вести уроки информатики у студентов-медиков. Я начал работать и увидел, что интерес к предмету очень слабый. Задумался, как сделать занятия увлекательными и полезными. И решил совместить изучение предмета с изучением клавиатуры.

Идея простая — давать студентам небольшие тексты по теме урока, чтобы они их перепечатывали. Но как добиться именно 10-пальцевой печати?

Сначала я попробовал сделать карточки с изображением клавиатуры. На карточках цветом выделены зоны для каждого пальца. Перед тем как напечатать букву, надо было посмотреть на карточку и задействовать соответствующий палец. Идея сработала, студенты начали потихоньку печатать. Но были и неудобства. Карточка лежала сбоку от клавиатуры, там же где и текст. При печати приходилось крутить головой: карточка — текст — экран. Ну, и на клавиатуру иногда посматривали.

Чтобы упростить процесс, я решил перенести карточку на экран. Как? Очень просто. Открыл файл Excel, расширил верхнюю строчку и вставил туда рисунок клавиатуры. А строчку «заморозил». Теперь ниже можно печатать сколько угодно текста, рисунок-подсказка всегда стоит перед глазами.

Уточню насчет рисунка. При распределении зон для пальцев существуют разные варианты. Я использовал вариант, который предлагает Министерство образования в учебнике информатики за 7 класс, автор Босова Л.Л. Но одного рисунка с клавиатурой мало. Надо ещё отработать движение рук.

Привет Хабр! В нашем блоге кейс-пополнение. Дисклеймер: По причине соглашений о неразглашении (NDA) мы не всегда можем указать на конкретного заказчика, но стараемся описывать задачу проекта и ее решение максимально подробно. Сегодня рассказ про применение ИИ в российской металлургии. Итак, после предисловия перейдем к теме статьи.

Давным-давно, кажется в позапрошлый вторник,  в одной из статей была поднята тема зарабатывания денег, где я поделился личным опытом работы на программных проектах, на рентабельность которых существенно повлияла проектная и эксплуатационная документация. По аналогии с фильмом "MoneyBall" материалы этой серии я объединил под названием "MoneyDev".

Сказка, которую вы сможете прочитать под катом, является логическим продолжением этой серии.

Привет! Я Оля Коршунова, лид первой редакции технических писателей в Т-Банке. Боль технических писателей — как определить влияние текста? Как оцифровать его в бизнес-результат?

Определить влияние текста на продукт бывает сложно: это всегда часть чего-то большего. Сначала у нас не было процессов, но мы выстроили работу с командами и научились закрывать боли.

В статье расскажу, с чего команда начинала работу и как пришла к метрикам документации.

Документация к инфраструктуре устаревает быстрее, чем коммиты попадают в main ветку, но мы решили эту «боль», отдав её на откуп ИИ. В статье разбираем, как связка из нескольких LLM-агентов автоматически парсит Ansible-плейбуки, генерирует пользовательские инструкции, проверяет и переводит их. Всё это крутится на четырёх Tesla V100 с ручной балансировкой через Ollama и OpenWebUI — без свежего железа, но с десятками сэкономленных часов и гарантией актуальности текстов.

Привет!

В этой статье хочу поделиться способом создания диаграмм последовательности, на которых пользователь может сам изменять степень детализации отображаемой информации.

Если хочет — может раскрыть больше деталей, если нужно наоборот — может скрыть избыточные.

А также, помимо самого способа создания, хочу рассказать, как получилось прийти именно к такому варианту динамических диаграмм последовательности.

Будет PlantUML, JavaScript, HTML и немного разочарования в ИИ :-)

P.S. Не смотрите на то, что читать статью якобы много-много минут. Текста там не много, все код виноват :-)

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

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

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

Когда я узнал, что Anthropic публикует 250-страничный технический документ для модели, которую не пустили в паблик с пометкой «вооружен и опасен», подумалось, что такое стоит читать целиком.

Не ради хайпа про хакерский AI, а ради понимания, куда движется вся индустрия и что это означает для тех, кто строит продукты на основе больших моделей сегодня. Я уже уверен, что это — один из самых важных документов на сегодня.

В этой статье на примере продуктов Контура разберём, зачем нужен глоссарий, какую пользу он даёт и как внедрить его в свою документацию.

Если вы решили внедрять искусственный интеллект в ваш проект, то скорее всего наступит момент когда потребуется технические задание. Так как внедрять ИИ часто начинают уже «прокачанные» пользователи ChatGPT, то возникает соблазн отдать написание этого самого ТЗ самому ИИ. А возможно еще и разослав это ТЗ разным исполнителям, оценить с помощью ИИ их предложения. Что может при этом пойти не так, разберем в этой статье.

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

В статье есть: какие проблемы могут быть в сгенерированном ИИ ТЗ на внедрение ИИ (с примерами), к чему приведет его использование и небольшой совет для чего все-таки можно использовать ИИ при подготовке ТЗ

Хабровчане, приветствую! Меня зовут Михаил Казанцев, я ведущий системный аналитик в мобильном приложении Вайлдберриз. Работал и писал требования как в стартапах с монолитами, так и в банковском секторе с сотнями сервисов в одном контуре, рассказать есть что.

Я хочу рассказать о своём восприятии основной идеи книги Мартина Клепмана — Высоконагруженные приложения через призму своего ультрамарафонского опыта тренировок и соревнований и практики проведения чайных церемоний. Книга технически сложная, поэтому

Вы открываете чат. Загружаете договор на 80 страниц или корпоративный регламент на 200. Пишете: «Добавь в раздел 4.2 новый пункт про порядок согласования».

AI читает весь документ целиком. Находит (или не находит) нужное место. Что‑то вставляет. Иногда попадает, иногда — нет. Иногда ломает форматирование соседних таблиц. Иногда забывает, что этот же раздел нужно синхронизировать с приложением.

Дело не в мощности модели. Дело в том, что она работает вслепую: нет карты документа, нет правил редактирования, нет понимания что с чем связано или неприкосновенно.

Адепты Agile‑манифеста зачастую весьма скептически относятся к процессу формирования документации на программных проектах. Как нельзя лучше это отношение сформулировал один эффективный перспективный руководитель отдела программирования, выпускник факультета менеджмента, который охарактеризовал документацию как «кучу макулатуры, которая генерится техписом и сдается в архив». В ту пору, когда я был молодым и перспективным, я тоже так думал. Но, как говорится, время лечит.

Статья носит исключительно образовательный/ознакомительный характер. Она не служит цели, рекламировать какой-либо инструмент или ПО. Все наименования программного обеспечения, упомянутые в статье приведены из личного опыта.

На днях прислали в рабочую почту очередное ТЗ в Word на разработку, для комментирования и оценки реализации. При том что у нас есть корпоративный Confluence - мощнейшая система, как раз предназначенная для коллективной работы.

Почему многие до сих пор продолжают изначально использовать Word как основу для обмена информацией?

Привет, Хабр! Мы уже разбирали OVN в связке с OpenStack и трассировку пакетов. А сегодня предлагаем почитать перевод документации про Quality of Service (QoS) в Neutron: что это, какие правила поддерживаются, как настроить и как работать с политиками.