Продвижение в GitHub для крипто: понятное присутствие разработчика для вашего токен-проекта

Начните с того, какая помощь нужна вашим репозиториям

Аудит присутствия в GitHub может быть сосредоточен на рекомендациях, улучшении текстов или поддержке документации. Сначала мы согласовываем, какие репозитории важны. Также мы согласовываем, что вы хотите, чтобы посетитель понял.

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

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

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

Сделайте проект более понятным до того, как придет внимание

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

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

Такой аудит касается готовности, а не добавления активности ради активности. Мы смотрим на то, что человек может увидеть. Мы также учитываем, что команда может поддерживать в актуальном состоянии. Результатом может быть более полезное начало README, лучше расположенное руководство по настройке или более понятный путь для технических вопросов.

Допустим, у вашего проекта два репозитория: один для инструмента, другой для примеров. Их описания могут не объяснять, как они связаны. Мы отмечаем связь и предлагаем, где должно быть объяснение. Ваша команда решает, вносить ли правку. Технический ответственный сначала проверяет ее.

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

Что должен ли новый контрибьютор понять самостоятельно?

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

Начните с простого объяснения

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

Сделайте первое действие видимым

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

Сохраняйте четкую передачу

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

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

Три контрольные точки переводят работу от ссылок к применимым изменениям

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

1. Поделитесь отправной точкой. Отправьте ссылки на репозитории, краткое описание продукта и людей, которым должны служить материалы. Укажите любые приватные или чувствительные области, которые должны остаться вне аудита.
2. Согласуйте, что мы будем проверять. Мы подтверждаем репозитории и документы. Мы также подтверждаем, нужны ли вам рекомендации или поддержка текстов, и кто может проверить техническую информацию.
3. Проверьте путь посетителя. Мы смотрим на описания репозиториев, содержимое README, ссылки на документацию и руководство по контрибуции. Результаты группируются по тому, что нужно читателю и кто может действовать по каждому пункту.
4. Проверьте факты вместе. Ваш технический контакт проверяет предложенные формулировки и подтверждает, какие детали точны. Мы оставляем утверждения о поведении продукта и реализации для проверки вашей командой.
5. Передайте работу. Вы получаете согласованный список действий и любую включенную поддержку текстов или документации с четким указанием ответственных.

Мы устанавливаем сроки после просмотра количества репозиториев и объема задействованных материалов. Один названный контакт с вашей стороны помогает продвигать технические вопросы. Если ваш проект также использует рост сообщества в Telegram или рост сообщества в Discord, поделитесь этими местами назначения. Мы сможем проверить, как GitHub направляет к ним посетителей.

Поддерживайте публичные материалы в актуальном состоянии после аудита

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

Для каждого согласованного изменения назначьте одного ответственного и место, где должно быть обновление. Технические инструкции требуют подтверждения от разработчика. Описания проектов и ссылки требуют кого-то, кто может поддерживать их актуальность. Простая проверка может спросить, соответствует ли README продукту. Она также может проверить, работают ли ключевые ссылки. Затем подтвердите, отражает ли руководство по контрибуции процесс, которому следует ваша команда.

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

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

Если вы готовы начать, отправьте нам ссылки на репозитории, краткое описание проекта и аудиторию, которую вы хотите охватить. Мы проверим отправную точку с вами, подтвердим границы и согласуем следующие шаги.

Как мы работаем

1. Поделитесь контекстом проектаОтправьте ссылки на репозитории, краткое описание продукта и аудиторию, которую вы хотите охватить. Укажите любую информацию, которая должна оставаться приватной.
2. Согласуйте границы аудитаМы подтверждаем, какие репозитории и документы проверять, какой вид поддержки вам нужен и кто может проверить технические детали.
3. Проверьте и организуйте результатыМы смотрим на публичный опыт и сортируем практические действия по потребностям читателя и ответственности.
4. Проверьте технические формулировкиВаш технический контакт подтверждает предложенные детали до того, как ваша команда опубликует или использует их.
5. Получите согласованную работуМы передаем приоритезированные действия и любую включенную поддержку текстов или документации.