Обновить
32K+

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

Всё о деятельности технических писателей

34,05
Рейтинг
Сначала показывать
Порог рейтинга
Уровень сложности

Tg базового материала печатной платы: что это и почему важно

Время на прочтение4 мин
Охват и читатели8.5K

При выборе материала для печатной платы инженеры и конструкторы обращают внимание на множество параметров. Один из ключевых — температура стеклования, или Tg. Этот показатель определяет, как поведёт себя плата при нагреве, и напрямую влияет на надёжность готового изделия.

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

Читать далее

Новости

ГОСТы по ИИ. Разбираю 5 стандартов

Уровень сложностиПростой
Время на прочтение10 мин
Охват и читатели6.1K

С 1 января 2025 года в России уже действует пакет национальных стандартов по искусственному интеллекту.

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

Читать далее

Как мы описали 15 000 таблиц за полгода вместо 500 за год — и перестали писать документацию руками

Время на прочтение10 мин
Охват и читатели10K

Годы идут, но что‑то остаётся неизменным: писать документацию никто не любит, но тем не менее все почему‑то ругают тех, кто её не пишет.

В Яндексе одних только таблиц с данными — десятки миллионов, общим объёмом в экзабайты данных. Даже когда мы оставляем из всего этого количества только самое востребованное, остаётся несколько десятков тысяч таблиц, которые кто‑то должен описать словами: что внутри, откуда взялось, можно ли этому доверять. Без таких описаний аналитик не находит данные через поиск, не понимает, что лежит в таблице, и заново собирает то, что уже собрал коллега. И страдает не только человек: ИИ‑агенты, которые всё чаще сами решают аналитические задачи, на неописанных данных также теряют в качестве — чем меньше известно про таблицу, тем хуже результат.

Год мы уговаривали людей описывать таблицы вручную — и собрали описания всего на 500 таблиц из 40 тысяч. Если описывать все данные с такой скоростью (при учёте, что постоянно появляются новые) — страшно представить, на сколько десятков лет мог бы растянуться этот процесс.

Меня зовут Роман Гриднев, я технический менеджер в Яндексе. Расскажу, как мы научились не писать документацию. «Не писать‑то все могут», — скажете вы. Но мы подключили к задаче LLM и дали людям вместо чистого листа черновик: пусть с ошибками, зато не пустую страницу, которая пугает. За полгода мы так описали 15 тысяч таблиц и сэкономили около пяти лет рабочего времени аналитиков. Со временем качество черновиков от LLM доросло до почти полного соответствия описаниям, сделанным людьми. 

Читать далее

Как QA я все равно пишу документацию, но с ИИ трачу на нее часы, а не дни

Уровень сложностиПростой
Время на прочтение9 мин
Охват и читатели7.6K

В статье я расскажу, как решал проблемы погружения в проект сначала вручную, а потом с помощью ИИ-инструментов и как мне удалось сократить путь от дней и недель до нескольких часов. Мой опыт пригодится QA-инженерам, которым приходится разбираться в новых проектах, систематизировать знания о продукте и поддерживать документацию в актуальном состоянии.

Читать далее

Нужна ли проектная документация в 26 году и что если ты пришел на новый проект, а там хаос и пустота?

Уровень сложностиПростой
Время на прочтение7 мин
Охват и читатели7.8K

«Это же бюрократия, у нас и так всё работает!» / «Документация — это отлично, но у нас есть задачи поважнее» / «Катя, я пришла на проект, а у них ничего, а у нас аудит». Эти фразы и еще много подобного я слышала так много раз, что кажется, время этой статьи пришло).

Мой путь от скептика к как меня в шутку называют коллеги «документатору‑злодею» и мысли о том, зачем же нам все таки нужно уметь и делать проектную документацию.

Путь от скептика к «документатору-злодею»

Инструкция: как зарегистрировать товарный знак в Роспатенте?

Время на прочтение9 мин
Охват и читатели7.6K

В инструкции приводится разбор процесса самостоятельной регистрации товарного знака в Роспатенте, в том числе:

1) определения объема правовой охраны товарного знака, подбор товаров и услуг, а также классов МКТУ;

2) особенности подготовки и подачи заявки по шагам через сервис «АРМ Регистратор» (самый надежный способ);

3) расчет и оплата пошлин за каждый этап регистрации;

4) общее описания процедуры: формальная экспертиза и экспертизы по существу;

5) ТОП-10 самых распространенных причин для отказа в регистрации.

Читать далее

Реестр отечественного ПО без юридического квеста: инструкция для авторов решений 1С

Уровень сложностиПростой
Время на прочтение2 мин
Охват и читатели6.8K

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

На Инфостарте опубликована пошаговая инструкция по включению решений 1С в Реестр отечественного ПО. В статье разобрано, какие продукты можно зарегистрировать, кто вправе подать заявку и как подтвердить, что программа существует, используется, развивается и поддерживается...

Читать далее

Права на программу для ЭВМ

Время на прочтение16 мин
Охват и читатели9.2K

В статье рассматриваются ответы на следующие вопросы:

1) Что такое программа для ЭВМ с юридической точки зрения

2) Какие элементы программы для ЭВМ защищаются авторским правом?

3) Кто признается автором программы для ЭВМ?

4) Основные сценарии создания программы и распределения прав на нее

5) Личные неимущественные права автора программы для ЭВМ

6) Имущественные (исключительные) права автора программы для ЭВМ

7) Предоставление права использования и отчуждение исключительных прав

8) Права законного пользователя программы для ЭВМ

9) Ответственность за нарушение прав на программное обеспечение

Читать далее

Одна ошибка, и ты ошибся: как сохранить доверие к ИТ-продукту

Время на прочтение8 мин
Охват и читатели7.8K

Привет, Хабр! Меня зовут Мария, я технический писатель в ИнфоТеКС. Представьте: вы запускаете новое приложение, тщательно проработанное, с инновационными возможностями и безупречным дизайном. Пользователь открывает описание функции и встречает ошибки. Например, «Выберите цепочку, содержаЩЕЕ правило».

Что происходит в этот момент? Небольшая опечатка, грамматическая ошибка или стилистическая неточность — и доверие к продукту подрывается, а значит, и к вашей компании. Проблема в том, что даже единичная небрежность в документации может свести на нет все усилия по созданию качественного продукта. Ведь небрежность в документации сразу бьёт по доверию: если текст не вычитан, то насколько надёжен сам продукт?

Чтобы такие ситуации не доходили до пользователей, в ИнфоТеКС выстроена система ревью, где ошибки выявляются и исправляются до публикации. Однако мы решили пойти дальше и посмотреть на ошибки системно — чтобы не просто править, а предотвращать их ещё на этапе создания черновика. Именно для этого провели «работу над ошибками» и проанализировали, какие недочёты возникают чаще всего.

Читать далее

Можно ли аналитику в 2026 году положиться на ИИ и агентов или ещё нет?

Уровень сложностиСредний
Время на прочтение15 мин
Охват и читатели10K

В какой-то момент у нас, как и у многих команд, появился соблазн проверить: а можно ли уже не просто просить AI «написать user story», а действительно встроить его в рабочий процесс аналитика? Например, дать агенту вводные по задаче, макеты в Figma, примеры документации и требования к оформлению, и получить на выходе нормальный Use Case, API-спецификацию, PlantUML-диаграмму и аккуратную страницу в Confluence.

Звучит красиво. 

Особенно если вы когда-нибудь вручную переносили сценарии из заметок в Confluence, сверяли шаги с макетами, оформляли вкладки с HTTP-запросами, проверяли коды ошибок и пытались не забыть все вопросы, которые «надо потом уточнить».

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

Читать далее

Внутренняя документация, которую никто не читает. Как сделать, чтобы читали (на примере ONLYOFFICE Workspace)

Уровень сложностиПростой
Время на прочтение12 мин
Охват и читатели9.6K

Документация умирает не от лени сотрудников, а из-за неудобства и потери доверия к данным. Разбираем «два кита» качественной базы знаний: удобство использования и контроль актуальности. Показываем на примере ONLYOFFICE Workspace, как превратить хаос в работающий процесс с помощью шаблонов, ролевой модели доступа и дисциплины пересмотра.

Читать далее

Новая версия языка разметки текстов Markvan

Уровень сложностиСредний
Время на прочтение4 мин
Охват и читатели17K

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

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

Узнать про альтернативный способ разметки

Подготовка данных: как мы формируем производственные панели

Время на прочтение4 мин
Охват и читатели16K

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

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

Читать далее

Ближайшие события

От хаоса к системе: как мы выстроили процесс Discovery (часть 2)

Время на прочтение7 мин
Охват и читатели8.2K

В предыдущей статье мы рассмотрели общий процесс работы аналитиков. 

Здесь подробнее остановимся на ключевых этапах подготовки постановки.

Разберём, как именно выстроена аналитическая работа внутри upstream: от преданализа до груминга, и какие практики помогают повышать качество требований и снижать риски на этапе разработки.

Читать далее

Аудит интеллектуальной собственности: как подготовиться к нему до привлечения инвесторов?

Время на прочтение7 мин
Охват и читатели5.8K

Аудит интеллектуальной собственности – это комплексная проверка всех нематериальных активов проекта: патентов и средств индивидуализации (товарных знаков, логотипов, коммерческих обозначений), авторских прав (ПО, дизайн, контент) и ноу-хау.

Главная задача аудита – понять, какие активы есть, кому они принадлежат, насколько корректно оформлены права и нет ли риска использования чужой интеллектуальной собственности.

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

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

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

Читать далее

30 дней из жизни архитектора контента: проверяем теорию практикой

Уровень сложностиПростой
Время на прочтение8 мин
Охват и читатели7.7K

Всем привет!

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

Сегодня я предлагаю перейти от слов к делу. Я проанализировала работу команды из четырех архитекторов контента за один месяц и подготовила детальный разбор без приукрашивания: покажу, как описанные ранее функции воплощаются в жизнь, к каким результатам пришли за 30 дней. Уверена, что такой отчет позволит вам увидеть реальную ценность архитектора контента для команды и оптимизации рабочих процессов. Запаситесь чашечкой кофе, будет много деталей!

Читать далее

— Егор, а можешь показать свой AGENTS.md?

Время на прочтение9 мин
Охват и читатели24K

Да не вопрос! На самом деле буквально три месяца назад у меня вообще не было никакого AGENTS.md. Он появился автоматом, когда я устанавливал code-review-graph.

История такая: я каждый день провожу стримы на Ютубе, где показываю процесс разработки своего проекта. И однажды в чатике мне посоветовали воспользоваться code-review-graph, чтобы сэкономить токенов в Codex. Я воспользовался советом, запустил установку через терминал — и в проекте автоматом появилась куча инструкций для разных агентов. Среди этих инструкций оказался и AGENTS.md.

Если вы, как и я поначалу, мало что понимаете в этих терминах и для чего они нужны, — сейчас объясню. А если вы полностью в теме — просто покажу кусочек своей «кухни».

Читать далее

Стриминг ZIP‑архивов на лету с nginx + mod_zip — просто, как 2 байта переслать

Уровень сложностиСредний
Время на прочтение8 мин
Охват и читатели6.9K

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

Читать далее

Шаблон ТЗ для проектирования REST API: готовый инструмент для аналитика

Уровень сложностиСредний
Время на прочтение9 мин
Охват и читатели7K

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

Читать далее

Какое вознаграждение работодатель должен выплатить автору служебного программного обеспечения (IT-решения) в 2026?

Время на прочтение15 мин
Охват и читатели5.7K

Структура статьи

1) В каких случаях программное обеспечение считается служебным?

2) В каких случаях у работодателя возникает обязанность выплатить авторское вознаграждение?

3) Может ли авторское вознаграждение быть включено в заработную плату?

4) Как определяется размер авторского вознаграждения?

5) Наиболее интересные судебные споры в РФ о выплате авторского вознаграждения

Читать далее
1
23 ...