Архив рубрики ‘readme’

5 ошибок в opensource‑проекте, из‑за которых DevRel превращается в мёртвый репозиторий

Привет, Хабр! Каждый год штук тридцать российских IT‑компаний открывают исходники какого‑нибудь своего внутреннего инструмента на GitHub с идеей «сейчас соберём вокруг него комьюнити и получим бесплатный DevRel‑канал». Через полтора года из этой тридцатки выживают три‑четыре проекта, у которых реально есть внешние контрибьюторы и звёзды продолжают капать. Остальные превращаются в архивные репозитории с 40 звёздами, парой висящих issue и последним коммитом восьмимесячной […]

Почему ваш GitHub — лучший лендинг, который можно сделать

Как README превращается в PR-актив: структура, нарратив, quickstart Когда кто-то впервые сталкивается с техническим продуктом, он открывает репозиторий. Инфлюенс, которому прислали питч, инвестор после дежурного «посмотрите наш продукт» делает то же самое, и разработчик, который наткнулся на тред в X, идёт туда же. Репозиторий — первая точка касания для аудитории с реальным весом: инженеры, тимлиды, […]

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

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