#документация — Public Fediverse posts

«Боргворглер: боргает ворглер», или как сделать действительно полезную документацию к проекту

Обсуждения неудачных примеров README-файлов и документации — одна из популярных тем на профильных площадках и форумах [вкупе с другими «вечнозелеными» спорами в ИТ]. Мы в

https://habr.com/ru/companies/beeline_cloud/articles/1036004/

#beeline_cloud #документация #readme #подготовка_документации #документирование_кода

Когда онбординг длится 2 месяца: день 3 — проследить главный поток данных

Иногда систему нужно быстро объяснить человеку со стороны: новому разработчику, техлиду, архитектору, аудитору или инвестору на technical due diligence. Но если показать все data flow сразу, человек не поймёт ничего. В этой части цикла я показываю, как выбрать один главный поток, проследить конкретную сущность от source до consumer и заранее привязать дебаг к слоям данных. Внутри 4 практичных артефакта: чек-лист выбора flow, карточка сущности, таблица изменения формы данных и чек-лист точек поломки. А чтобы схема осталась в памяти надолго, я обернула её в кальмара с полипом на лице.

https://habr.com/ru/articles/1035392/

#онбординг #data_flow #архитектура #документация #UML #API #SDK #debugging #legacy #рефакторинг

Когда онбординг длится 2 месяца: день 3 — проследить главный поток данных

Иногда систему нужно быстро объяснить человеку со стороны: новому разработчику, техлиду, архитектору, аудитору или инвестору на technical due diligence. Но если показать все data flow сразу, человек не поймёт ничего. В этой части цикла я показываю, как выбрать один главный поток, проследить конкретную сущность от source до consumer и заранее привязать дебаг к слоям данных. Внутри 4 практичных артефакта: чек-лист выбора flow, карточка сущности, таблица изменения формы данных и чек-лист точек поломки. А чтобы схема осталась в памяти надолго, я обернула её в кальмара с полипом на лице.

https://habr.com/ru/articles/1035392/

#онбординг #data_flow #архитектура #документация #UML #API #SDK #debugging #legacy #рефакторинг

Когда онбординг длится 2 месяца: день 3 — проследить главный поток данных

Иногда систему нужно быстро объяснить человеку со стороны: новому разработчику, техлиду, архитектору, аудитору или инвестору на technical due diligence. Но если показать все data flow сразу, человек не поймёт ничего. В этой части цикла я показываю, как выбрать один главный поток, проследить конкретную сущность от source до consumer и заранее привязать дебаг к слоям данных. Внутри 4 практичных артефакта: чек-лист выбора flow, карточка сущности, таблица изменения формы данных и чек-лист точек поломки. А чтобы схема осталась в памяти надолго, я обернула её в кальмара с полипом на лице.

https://habr.com/ru/articles/1035392/

#онбординг #data_flow #архитектура #документация #UML #API #SDK #debugging #legacy #рефакторинг

Когда онбординг длится 2 месяца: день 3 — проследить главный поток данных

Иногда систему нужно быстро объяснить человеку со стороны: новому разработчику, техлиду, архитектору, аудитору или инвестору на technical due diligence. Но если показать все data flow сразу, человек не поймёт ничего. В этой части цикла я показываю, как выбрать один главный поток, проследить конкретную сущность от source до consumer и заранее привязать дебаг к слоям данных. Внутри 4 практичных артефакта: чек-лист выбора flow, карточка сущности, таблица изменения формы данных и чек-лист точек поломки. А чтобы схема осталась в памяти надолго, я обернула её в кальмара с полипом на лице.

https://habr.com/ru/articles/1035392/

#онбординг #data_flow #архитектура #документация #UML #API #SDK #debugging #legacy #рефакторинг

Пользователь, they и Шекспир: история одного скандала

“User — это не he. User - это they. Аккуратно с этим в международных командах”. На днях из-за этой короткой заметки в моих соц. сетях разразился настоящий скандал. Возмущались в основном мужчины. Даже вялый прежде LinkedIn бушевал все майские.

https://habr.com/ru/articles/1035058/

#английский_язык #документация #английский #английский_язык_изучение #английский_язык_самообразование #английский_обучение_языки #английский_язык_онлайн #английский_онлайн #иностранные_языки #иностранный_язык

Код как документация: как мы строим самодокументируемые витрины данных в Почте Mail

В аналитике больших данных есть старая проблема: код ETL-витрин живет своей жизнью, а документация — своей. Изменяешь логику, забываешь обновить описание колонки — и через месяц никто не помнит, что означает wallet_cards_category_hits. В Почте Mail (VK) мы решили эту проблему системно, разработав внутренний фреймворк, который делает код витрины и ее документацию неразрывными. На связи Дима Швеенков. Я все так же руковожу направлением аналитики в команде и отвечаю за данные в Почте Mail , а теперь еще и отвечаю за DWH в VK Tech . В предыдущих статьях я подробно рассказывал о нашем Data Driven-подходе к работе с данными, а также, в частности, как мы работаем со Spark и какие ключевые проблемы с данными мы решили, чтобы построить свое хранилище данных. Сегодня хотел бы остановиться на более узкой теме — как держать в порядке документацию, если у вас такое же огромное хранилище, как и у нас. Материал короткий, но, надеюсь, будет для вас полезным.

https://habr.com/ru/companies/vktech/articles/1032686/

#big_data #apache_spark #airflow #clickhouse #sql #документация #dwh #metadata #dbt #vk_tech

Код как документация: как мы строим самодокументируемые витрины данных в Почте Mail

В аналитике больших данных есть старая проблема: код ETL-витрин живет своей жизнью, а документация — своей. Изменяешь логику, забываешь обновить описание колонки — и через месяц никто не помнит, что означает wallet_cards_category_hits. В Почте Mail (VK) мы решили эту проблему системно, разработав внутренний фреймворк, который делает код витрины и ее документацию неразрывными. На связи Дима Швеенков. Я все так же руковожу направлением аналитики в команде и отвечаю за данные в Почте Mail , а теперь еще и отвечаю за DWH в VK Tech . В предыдущих статьях я подробно рассказывал о нашем Data Driven-подходе к работе с данными, а также, в частности, как мы работаем со Spark и какие ключевые проблемы с данными мы решили, чтобы построить свое хранилище данных. Сегодня хотел бы остановиться на более узкой теме — как держать в порядке документацию, если у вас такое же огромное хранилище, как и у нас. Материал короткий, но, надеюсь, будет для вас полезным.

https://habr.com/ru/companies/vktech/articles/1032686/

#big_data #apache_spark #airflow #clickhouse #sql #документация #dwh #metadata #dbt #vk_tech

Код как документация: как мы строим самодокументируемые витрины данных в Почте Mail

В аналитике больших данных есть старая проблема: код ETL-витрин живет своей жизнью, а документация — своей. Изменяешь логику, забываешь обновить описание колонки — и через месяц никто не помнит, что означает wallet_cards_category_hits. В Почте Mail (VK) мы решили эту проблему системно, разработав внутренний фреймворк, который делает код витрины и ее документацию неразрывными. На связи Дима Швеенков. Я все так же руковожу направлением аналитики в команде и отвечаю за данные в Почте Mail , а теперь еще и отвечаю за DWH в VK Tech . В предыдущих статьях я подробно рассказывал о нашем Data Driven-подходе к работе с данными, а также, в частности, как мы работаем со Spark и какие ключевые проблемы с данными мы решили, чтобы построить свое хранилище данных. Сегодня хотел бы остановиться на более узкой теме — как держать в порядке документацию, если у вас такое же огромное хранилище, как и у нас. Материал короткий, но, надеюсь, будет для вас полезным.

https://habr.com/ru/companies/vktech/articles/1032686/

#big_data #apache_spark #airflow #clickhouse #sql #документация #dwh #metadata #dbt #vk_tech

Код как документация: как мы строим самодокументируемые витрины данных в Почте Mail

В аналитике больших данных есть старая проблема: код ETL-витрин живет своей жизнью, а документация — своей. Изменяешь логику, забываешь обновить описание колонки — и через месяц никто не помнит, что означает wallet_cards_category_hits. В Почте Mail (VK) мы решили эту проблему системно, разработав внутренний фреймворк, который делает код витрины и ее документацию неразрывными. На связи Дима Швеенков. Я все так же руковожу направлением аналитики в команде и отвечаю за данные в Почте Mail , а теперь еще и отвечаю за DWH в VK Tech . В предыдущих статьях я подробно рассказывал о нашем Data Driven-подходе к работе с данными, а также, в частности, как мы работаем со Spark и какие ключевые проблемы с данными мы решили, чтобы построить свое хранилище данных. Сегодня хотел бы остановиться на более узкой теме — как держать в порядке документацию, если у вас такое же огромное хранилище, как и у нас. Материал короткий, но, надеюсь, будет для вас полезным.

https://habr.com/ru/companies/vktech/articles/1032686/

#big_data #apache_spark #airflow #clickhouse #sql #документация #dwh #metadata #dbt #vk_tech

Как мы сделали автогенерацию документации для CI/CD из комментариев в коде

Привет, Хабр! Меня зовут Николай Чурянин, я занимаюсь iOS-разработкой в ПСБ. Сегодня я хочу рассказать вам, как делал новую документацию для нашего модуля CI/CD. Конечно же, документация у нас была и раньше. И даже не одна — а это, как понимаете, только усугубляло проблему. Часть документации лежала в readme-репозитории — с него-то она по сути и началась. Но обновлялась она там нерегулярно, оказалось, что работать с ней было не очень-то удобно. В какой-то момент этот репозиторий перестали поддерживать, и я попытался оформить её на внутреннем портале. Увы, пользы от этого стало ещё меньше: там документация была оторвана от кода — от наших скриптов. Вдобавок, её было трудно обновлять. Надо ли говорить, что и её забросили? «Совсем без документации тоже нельзя», — решил я и принялся искать другой способ. И нашёл его (спойлер: без ИИ тут не обошлось). Покажу, что получилось и как всё теперь работает.

https://habr.com/ru/companies/psb/articles/1032854/

#ci_cd #документация #документация_проекта #документация_это_легко #ии #ии_и_машинное_обучение

Без документации ИИ далеко не уедет: мои грабли на проекте

На этой неделе я побывал в клубе AI Practiq, где ребята собираются, обсуждают вайбкодинг , делятся опытом и практиками. Один из участников рассказывал о своём опыте и выделил четыре важных аспекта качественной разработки с ИИ. Один из них - документация . Это очень точно совпало с моими ощущениями. Размышляю вслух, делюсь впечатлениями и своим опытом.

https://habr.com/ru/articles/1033942/

#практика_программирования #искусственный_интеллект #вайбкодинг #вайбпрограммирование #вайбкодинг #вайбкод #вайб_кодинг #вайбокодинг #обмен_опытом #документация

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Veai 5.10: общие скиллы и подсказки в чате

Главное в Veai 5.10 – скиллы теперь подхватываются из dot-директорий других ассистентов. В чат добавили быструю документацию по ссылкам на код. Запуск и получение конфигураций в Rider До Veai 5.10 в C#/.NET-проекте нужно было просить агента прогнать тесты в модуле или собрать проект. Агент шёл в терминал и пытался угадать команду: какой dotnet , какой TFM, какой фильтр и какой путь к csproj. На монорепо с несколькими SDK и global.json это регулярно заканчивалось exit code 1 и попыткой починить рабочий код.

https://habr.com/ru/companies/veai/articles/1032012/

#aiагенты #llm #автоматизация_тестирования #генерация_кода_ai #автоматизация_разработки #ai_в_разработке #автоматическая_генерация_кода #ииассистент #intellij_idea_plugin #документация

Veai 5.10: общие скиллы и подсказки в чате

Главное в Veai 5.10 – скиллы теперь подхватываются из dot-директорий других ассистентов. В чат добавили быструю документацию по ссылкам на код. Запуск и получение конфигураций в Rider До Veai 5.10 в C#/.NET-проекте нужно было просить агента прогнать тесты в модуле или собрать проект. Агент шёл в терминал и пытался угадать команду: какой dotnet , какой TFM, какой фильтр и какой путь к csproj. На монорепо с несколькими SDK и global.json это регулярно заканчивалось exit code 1 и попыткой починить рабочий код.

https://habr.com/ru/companies/veai/articles/1032012/

#aiагенты #llm #автоматизация_тестирования #генерация_кода_ai #автоматизация_разработки #ai_в_разработке #автоматическая_генерация_кода #ииассистент #intellij_idea_plugin #документация

Veai 5.10: общие скиллы и подсказки в чате

Главное в Veai 5.10 – скиллы теперь подхватываются из dot-директорий других ассистентов. В чат добавили быструю документацию по ссылкам на код. Запуск и получение конфигураций в Rider До Veai 5.10 в C#/.NET-проекте нужно было просить агента прогнать тесты в модуле или собрать проект. Агент шёл в терминал и пытался угадать команду: какой dotnet , какой TFM, какой фильтр и какой путь к csproj. На монорепо с несколькими SDK и global.json это регулярно заканчивалось exit code 1 и попыткой починить рабочий код.

https://habr.com/ru/companies/veai/articles/1032012/

#aiагенты #llm #автоматизация_тестирования #генерация_кода_ai #автоматизация_разработки #ai_в_разработке #автоматическая_генерация_кода #ииассистент #intellij_idea_plugin #документация

Veai 5.10: общие скиллы и подсказки в чате

Главное в Veai 5.10 – скиллы теперь подхватываются из dot-директорий других ассистентов. В чат добавили быструю документацию по ссылкам на код. Запуск и получение конфигураций в Rider До Veai 5.10 в C#/.NET-проекте нужно было просить агента прогнать тесты в модуле или собрать проект. Агент шёл в терминал и пытался угадать команду: какой dotnet , какой TFM, какой фильтр и какой путь к csproj. На монорепо с несколькими SDK и global.json это регулярно заканчивалось exit code 1 и попыткой починить рабочий код.

https://habr.com/ru/companies/veai/articles/1032012/

#aiагенты #llm #автоматизация_тестирования #генерация_кода_ai #автоматизация_разработки #ai_в_разработке #автоматическая_генерация_кода #ииассистент #intellij_idea_plugin #документация

AI-friendly и AI-first: как адаптировать ИТ-проекты под эру LLM

Привет, Хабр! Последние полгода стало модно создавать новые и переводить старые проекты на рельсы AI-First (или AI-Friendly) стандарта. Уже появляются проекты, которые декларируются как «designed for AI to write». Например, AIR — AI-First веб-фреймворк на Python. В этой статье я хочу рассказать о том, как сделать свой проект дружелюбным для ИИ и тем самым повысить его юзабилити и помочь пользователям быстрее начать им пользоваться. ИИ-агенты стали новыми потребителями вашего кода. У них своя экономика токенов, свои требования к проекту и его документации. Хорошая новость в том, что настроить все можно за несколько часов — будь то забытый корпоративный микросервис или новый opensource-проект. Это может пригодиться как создателям открытых проектов, так и разработчикам внутренних корпоративных проектов. Итак, начнем с матчасти.

https://habr.com/ru/companies/ru_mts/articles/1027642/

#документация #AGENTSmd #agents #aifriendly #aifrist #ai_friendly #ai_first #llmstxt #LLM #ииагенты

AI-friendly и AI-first: как адаптировать ИТ-проекты под эру LLM

Привет, Хабр! Последние полгода стало модно создавать новые и переводить старые проекты на рельсы AI-First (или AI-Friendly) стандарта. Уже появляются проекты, которые декларируются как «designed for AI to write». Например, AIR — AI-First веб-фреймворк на Python. В этой статье я хочу рассказать о том, как сделать свой проект дружелюбным для ИИ и тем самым повысить его юзабилити и помочь пользователям быстрее начать им пользоваться. ИИ-агенты стали новыми потребителями вашего кода. У них своя экономика токенов, свои требования к проекту и его документации. Хорошая новость в том, что настроить все можно за несколько часов — будь то забытый корпоративный микросервис или новый opensource-проект. Это может пригодиться как создателям открытых проектов, так и разработчикам внутренних корпоративных проектов. Итак, начнем с матчасти.

https://habr.com/ru/companies/ru_mts/articles/1027642/

#документация #AGENTSmd #agents #aifriendly #aifrist #ai_friendly #ai_first #llmstxt #LLM #ииагенты

AI-friendly и AI-first: как адаптировать ИТ-проекты под эру LLM

Привет, Хабр! Последние полгода стало модно создавать новые и переводить старые проекты на рельсы AI-First (или AI-Friendly) стандарта. Уже появляются проекты, которые декларируются как «designed for AI to write». Например, AIR — AI-First веб-фреймворк на Python. В этой статье я хочу рассказать о том, как сделать свой проект дружелюбным для ИИ и тем самым повысить его юзабилити и помочь пользователям быстрее начать им пользоваться. ИИ-агенты стали новыми потребителями вашего кода. У них своя экономика токенов, свои требования к проекту и его документации. Хорошая новость в том, что настроить все можно за несколько часов — будь то забытый корпоративный микросервис или новый opensource-проект. Это может пригодиться как создателям открытых проектов, так и разработчикам внутренних корпоративных проектов. Итак, начнем с матчасти.

https://habr.com/ru/companies/ru_mts/articles/1027642/

#документация #AGENTSmd #agents #aifriendly #aifrist #ai_friendly #ai_first #llmstxt #LLM #ииагенты

AI-friendly и AI-first: как адаптировать ИТ-проекты под эру LLM

Привет, Хабр! Последние полгода стало модно создавать новые и переводить старые проекты на рельсы AI-First (или AI-Friendly) стандарта. Уже появляются проекты, которые декларируются как «designed for AI to write». Например, AIR — AI-First веб-фреймворк на Python. В этой статье я хочу рассказать о том, как сделать свой проект дружелюбным для ИИ и тем самым повысить его юзабилити и помочь пользователям быстрее начать им пользоваться. ИИ-агенты стали новыми потребителями вашего кода. У них своя экономика токенов, свои требования к проекту и его документации. Хорошая новость в том, что настроить все можно за несколько часов — будь то забытый корпоративный микросервис или новый opensource-проект. Это может пригодиться как создателям открытых проектов, так и разработчикам внутренних корпоративных проектов. Итак, начнем с матчасти.

https://habr.com/ru/companies/ru_mts/articles/1027642/

#документация #AGENTSmd #agents #aifriendly #aifrist #ai_friendly #ai_first #llmstxt #LLM #ииагенты

[Перевод] Man pages, которыми хочется пользоваться: как сделать их удобными

Man-страницы часто остаются главным способом разобраться с CLI-инструментом, но в реальной работе быстро найти нужную опцию или пример бывает непросто. В статье разберем практичные приемы, которые делают такую документацию удобнее: сводки опций, группировка по сценариям, шпаргалки, примеры, таблицы и нормальная навигация в HTML-версиях. Всё на примерах Git, rsync, strace, curl, OpenBSD и GNU. Перейти к статье

https://habr.com/ru/companies/otus/articles/1029516/

#man_pages #manстраницы #документация #терминал #CLI #Linux #Unix #примеры_команд #техническая_документация

[Перевод] Man pages, которыми хочется пользоваться: как сделать их удобными

Man-страницы часто остаются главным способом разобраться с CLI-инструментом, но в реальной работе быстро найти нужную опцию или пример бывает непросто. В статье разберем практичные приемы, которые делают такую документацию удобнее: сводки опций, группировка по сценариям, шпаргалки, примеры, таблицы и нормальная навигация в HTML-версиях. Всё на примерах Git, rsync, strace, curl, OpenBSD и GNU. Перейти к статье

https://habr.com/ru/companies/otus/articles/1029516/

#man_pages #manстраницы #документация #терминал #CLI #Linux #Unix #примеры_команд #техническая_документация

[Перевод] Man pages, которыми хочется пользоваться: как сделать их удобными

Man-страницы часто остаются главным способом разобраться с CLI-инструментом, но в реальной работе быстро найти нужную опцию или пример бывает непросто. В статье разберем практичные приемы, которые делают такую документацию удобнее: сводки опций, группировка по сценариям, шпаргалки, примеры, таблицы и нормальная навигация в HTML-версиях. Всё на примерах Git, rsync, strace, curl, OpenBSD и GNU. Перейти к статье

https://habr.com/ru/companies/otus/articles/1029516/

#man_pages #manстраницы #документация #терминал #CLI #Linux #Unix #примеры_команд #техническая_документация

[Перевод] Man pages, которыми хочется пользоваться: как сделать их удобными

Man-страницы часто остаются главным способом разобраться с CLI-инструментом, но в реальной работе быстро найти нужную опцию или пример бывает непросто. В статье разберем практичные приемы, которые делают такую документацию удобнее: сводки опций, группировка по сценариям, шпаргалки, примеры, таблицы и нормальная навигация в HTML-версиях. Всё на примерах Git, rsync, strace, curl, OpenBSD и GNU. Перейти к статье

https://habr.com/ru/companies/otus/articles/1029516/

#man_pages #manстраницы #документация #терминал #CLI #Linux #Unix #примеры_команд #техническая_документация

MoneyDev: Сказка про три главных слова

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

https://habr.com/ru/companies/lanit/articles/1015458/

#ЛАНИТ #документация #финансы #управление_командой #управление_проектами #MoneyDev

MoneyDev: Сказка про три главных слова

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

https://habr.com/ru/companies/lanit/articles/1015458/

#ЛАНИТ #документация #финансы #управление_командой #управление_проектами #MoneyDev

MoneyDev: Сказка про три главных слова

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

https://habr.com/ru/companies/lanit/articles/1015458/

#ЛАНИТ #документация #финансы #управление_командой #управление_проектами #MoneyDev

MoneyDev: Сказка про три главных слова

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

https://habr.com/ru/companies/lanit/articles/1015458/

#ЛАНИТ #документация #финансы #управление_командой #управление_проектами #MoneyDev

Диагностика ОРД: как выявить «хромые» места в документах, пока их не нашел регулятор

Автор: Елизавета Пермякова, консультант по информационной безопасности Innostage Подход регуляторов к выстраиванию процессов информационной безопасности меняется. Регуляторы больше не спрашивают «есть ли у вас документы?». Теперь вопрос звучит иначе: «Как вы подтверждаете, что эти документы работают?». Для выполнения большинства моих рабочих задач мне необходимо анализировать существующую и разрабатывать недостающую организационно-распорядительную документацию для организаций из разных отраслей (это и ТЭК, и металлургия, и финансовые организации). На практике замечаю, где компании с низким уровнем зрелости ИБ допускают одни и те же ошибки, и благодаря каким подходам компании со средним и высоким уровнем зрелости ИБ – выстраивают работающие процессы ИБ. В этой статье я покажу, где обычно «хромает» документация, и дам лаконичный чек-лист, с которым большинство документов можно проверить примерно за 15 минут.

https://habr.com/ru/companies/innostage/articles/1023220/

#информационная_безопасность #иб #аудит_иб #документация #орд #зрелость_иб #регуляторы #фстэк_россии #роскомнадзор

Диагностика ОРД: как выявить «хромые» места в документах, пока их не нашел регулятор

Автор: Елизавета Пермякова, консультант по информационной безопасности Innostage Подход регуляторов к выстраиванию процессов информационной безопасности меняется. Регуляторы больше не спрашивают «есть ли у вас документы?». Теперь вопрос звучит иначе: «Как вы подтверждаете, что эти документы работают?». Для выполнения большинства моих рабочих задач мне необходимо анализировать существующую и разрабатывать недостающую организационно-распорядительную документацию для организаций из разных отраслей (это и ТЭК, и металлургия, и финансовые организации). На практике замечаю, где компании с низким уровнем зрелости ИБ допускают одни и те же ошибки, и благодаря каким подходам компании со средним и высоким уровнем зрелости ИБ – выстраивают работающие процессы ИБ. В этой статье я покажу, где обычно «хромает» документация, и дам лаконичный чек-лист, с которым большинство документов можно проверить примерно за 15 минут.

https://habr.com/ru/companies/innostage/articles/1023220/

#информационная_безопасность #иб #аудит_иб #документация #орд #зрелость_иб #регуляторы #фстэк_россии #роскомнадзор

Диагностика ОРД: как выявить «хромые» места в документах, пока их не нашел регулятор

Автор: Елизавета Пермякова, консультант по информационной безопасности Innostage Подход регуляторов к выстраиванию процессов информационной безопасности меняется. Регуляторы больше не спрашивают «есть ли у вас документы?». Теперь вопрос звучит иначе: «Как вы подтверждаете, что эти документы работают?». Для выполнения большинства моих рабочих задач мне необходимо анализировать существующую и разрабатывать недостающую организационно-распорядительную документацию для организаций из разных отраслей (это и ТЭК, и металлургия, и финансовые организации). На практике замечаю, где компании с низким уровнем зрелости ИБ допускают одни и те же ошибки, и благодаря каким подходам компании со средним и высоким уровнем зрелости ИБ – выстраивают работающие процессы ИБ. В этой статье я покажу, где обычно «хромает» документация, и дам лаконичный чек-лист, с которым большинство документов можно проверить примерно за 15 минут.

https://habr.com/ru/companies/innostage/articles/1023220/

#информационная_безопасность #иб #аудит_иб #документация #орд #зрелость_иб #регуляторы #фстэк_россии #роскомнадзор

Диагностика ОРД: как выявить «хромые» места в документах, пока их не нашел регулятор

Автор: Елизавета Пермякова, консультант по информационной безопасности Innostage Подход регуляторов к выстраиванию процессов информационной безопасности меняется. Регуляторы больше не спрашивают «есть ли у вас документы?». Теперь вопрос звучит иначе: «Как вы подтверждаете, что эти документы работают?». Для выполнения большинства моих рабочих задач мне необходимо анализировать существующую и разрабатывать недостающую организационно-распорядительную документацию для организаций из разных отраслей (это и ТЭК, и металлургия, и финансовые организации). На практике замечаю, где компании с низким уровнем зрелости ИБ допускают одни и те же ошибки, и благодаря каким подходам компании со средним и высоким уровнем зрелости ИБ – выстраивают работающие процессы ИБ. В этой статье я покажу, где обычно «хромает» документация, и дам лаконичный чек-лист, с которым большинство документов можно проверить примерно за 15 минут.

https://habr.com/ru/companies/innostage/articles/1023220/

#информационная_безопасность #иб #аудит_иб #документация #орд #зрелость_иб #регуляторы #фстэк_россии #роскомнадзор

Парсим MDN и пишем оффлайн RAG-MCP

Привет. В этой технической статье мы на практике разберёмся, что такое RAG, распарсим MDN Web Docs , научимся готовить эмбеддинги, заполним ими векторную базу данных и напишем свой MCP сервер с гибридным векторным и полнотекстовым поиском. Зальём всё получившееся добро на HuggingFace , GitHub и NPM , и настроим автоматическое обновление данных. Внутри будет много пошаговых инструкций и примеров кода на Bun + TypeScript.

https://habr.com/ru/articles/1019930/

#RAG #MCP #LLM #Документация #MDN

MoneyDev: как заработать на макулатуре

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

https://habr.com/ru/companies/lanit/articles/1015396/

#ЛАНИТ #документация #финансы #управление_командой #управление_проектами

MoneyDev: как заработать на макулатуре

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

https://habr.com/ru/companies/lanit/articles/1015396/

#ЛАНИТ #документация #финансы #управление_командой #управление_проектами

Как мы потеряли GitBook за 5 минут и нашли Gramax — open-source альтернативу, которую теперь используем сами

Один клик — и ваша документация может исчезнуть. Именно так и произошло с нами. Поэтому мы нашли open-source альтернативу, где данными владеем только мы — и никакой регион это не изменит.

https://habr.com/ru/articles/1019230/

#Gramax #GitBook #open_source #документация #docsascode #Markdown #Git #стартап #альтернатива_GitBook #командная_документация

Как мы потеряли GitBook за 5 минут и нашли Gramax — open-source альтернативу, которую теперь используем сами

Один клик — и ваша документация может исчезнуть. Именно так и произошло с нами. Поэтому мы нашли open-source альтернативу, где данными владеем только мы — и никакой регион это не изменит.

https://habr.com/ru/articles/1019230/

#Gramax #GitBook #open_source #документация #docsascode #Markdown #Git #стартап #альтернатива_GitBook #командная_документация

Как мы потеряли GitBook за 5 минут и нашли Gramax — open-source альтернативу, которую теперь используем сами

Один клик — и ваша документация может исчезнуть. Именно так и произошло с нами. Поэтому мы нашли open-source альтернативу, где данными владеем только мы — и никакой регион это не изменит.

https://habr.com/ru/articles/1019230/

#Gramax #GitBook #open_source #документация #docsascode #Markdown #Git #стартап #альтернатива_GitBook #командная_документация

Как мы потеряли GitBook за 5 минут и нашли Gramax — open-source альтернативу, которую теперь используем сами

Один клик — и ваша документация может исчезнуть. Именно так и произошло с нами. Поэтому мы нашли open-source альтернативу, где данными владеем только мы — и никакой регион это не изменит.

https://habr.com/ru/articles/1019230/

#Gramax #GitBook #open_source #документация #docsascode #Markdown #Git #стартап #альтернатива_GitBook #командная_документация

Вася уволился — и унёс с собой 80% знаний о системе

Однажды утром вы открываете задачу и понимаете: единственный человек, который знал, как это работает, вчера уволился. Знания ушли вместе с ним.

https://habr.com/ru/companies/simpleone/articles/1017882/

#bus_factor #база_знаний #онбординг #adr #документация #управление_знаниями #code_review

Вася уволился — и унёс с собой 80% знаний о системе

Однажды утром вы открываете задачу и понимаете: единственный человек, который знал, как это работает, вчера уволился. Знания ушли вместе с ним.

https://habr.com/ru/companies/simpleone/articles/1017882/

#bus_factor #база_знаний #онбординг #adr #документация #управление_знаниями #code_review

Вася уволился — и унёс с собой 80% знаний о системе

Однажды утром вы открываете задачу и понимаете: единственный человек, который знал, как это работает, вчера уволился. Знания ушли вместе с ним.

https://habr.com/ru/companies/simpleone/articles/1017882/

#bus_factor #база_знаний #онбординг #adr #документация #управление_знаниями #code_review

Вася уволился — и унёс с собой 80% знаний о системе

Однажды утром вы открываете задачу и понимаете: единственный человек, который знал, как это работает, вчера уволился. Знания ушли вместе с ним.

https://habr.com/ru/companies/simpleone/articles/1017882/

#bus_factor #база_знаний #онбординг #adr #документация #управление_знаниями #code_review

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

Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт, сложно будет искать и исправлять ошибки и проводить необходимые доработки, когда в них возникнет необходимость, и т.д. Обычно документацию делают по одному из двух путей – либо используют стандарты, описывающие требования к составу, структуре и содержанию документов (например, ГОСТ 19-й и 34-й серий – ЕСПД и КСАС), либо самостоятельно разрабатывают документ, создавая его на основе собственного опыта или по существующим образцам, в т.ч. взятых из интернета. Но как же её правильно сделать? Мой ответ - начинать надо с синопсиса документов.

https://habr.com/ru/articles/1015118/

#Синопсис #документация #документирование #документация_проекта #разработка_документации #техническая_документация #технический_писатель #техническое_задание

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

Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт, сложно будет искать и исправлять ошибки и проводить необходимые доработки, когда в них возникнет необходимость, и т.д. Обычно документацию делают по одному из двух путей – либо используют стандарты, описывающие требования к составу, структуре и содержанию документов (например, ГОСТ 19-й и 34-й серий – ЕСПД и КСАС), либо самостоятельно разрабатывают документ, создавая его на основе собственного опыта или по существующим образцам, в т.ч. взятых из интернета. Но как же её правильно сделать? Мой ответ - начинать надо с синопсиса документов.

https://habr.com/ru/articles/1015118/

#Синопсис #документация #документирование #документация_проекта #разработка_документации #техническая_документация #технический_писатель #техническое_задание

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

Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт, сложно будет искать и исправлять ошибки и проводить необходимые доработки, когда в них возникнет необходимость, и т.д. Обычно документацию делают по одному из двух путей – либо используют стандарты, описывающие требования к составу, структуре и содержанию документов (например, ГОСТ 19-й и 34-й серий – ЕСПД и КСАС), либо самостоятельно разрабатывают документ, создавая его на основе собственного опыта или по существующим образцам, в т.ч. взятых из интернета. Но как же её правильно сделать? Мой ответ - начинать надо с синопсиса документов.

https://habr.com/ru/articles/1015118/

#Синопсис #документация #документирование #документация_проекта #разработка_документации #техническая_документация #технический_писатель #техническое_задание