Все, чему я научился как менеджер по доставке при создании своего продукта

Сначала я начал обдумывать, как повысить вовлеченность в мой проект с открытым исходным кодом. Почему? Потому что:

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

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

В результате я решил создать интересный README.

Создайте хороший файл Readme

Это — первое, что видит посетитель вашего репозитория. Хороший README служит всеобъемлющей и доступной отправной точкой для взаимодействия пользователей и разработчиков с вашим проектом.

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

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

• CodeDocumentation.md – описывает, как документировать код. .
• CodeStyle.md — описывает стиль кода.< /ли>
• Constraints.md — описывает ограничения решения.< /ли>
• Dependologies.md — описывает используемые инструменты и библиотеки. для разработки продукта.
• DependologiesOld.md – описывает старые инструменты и библиотеки. которые использовались для разработки продукта.
• FunctionalView.md – показывает и описывает функциональное представление. .
• QualityAttributes.md — описывает атрибуты качества продукта.

Кроме того, мой **README начинается с логотипа продукта.

Значки

Затем README переходят к главам, посвященным значкам, которые могут оказаться полезными для разработчиков. Эти разделы включают в себя:

• Общие (звезды репозитория, участники, подписчики, спонсоры и URL-адрес Twitter)
• Выпуск (последняя версия выпуска, дата выпуска и количество загрузок)
• Статистика кода (статус процесса сборки, активность фиксации GitHub, последняя фиксация GitHub и статус CodeFactor.io)
• Проблемы и запросы на включение (проблемы GitHub, закрытые проблемы, запросы на включение и закрытые запросы на включение)
• Статистика репозитория (основной язык GitHub, количество языков и размер репозитория)
• Документация (схема действий, обсуждения, лицензия и основной файл README)

Существует три различных типа значков в зависимости от подхода к их реализации:

• Реализовано GitHub, отображается как: Значок GitHub< /a>
• Реализовано img.shields.io, отображается как: Значок
• Реализовано www.codefactor.io, отображается как: Значок

Быстрые ссылки

После этого README переходит к Быстрые ссылки< /strong> глава. Быстрые ссылки в файле README играют решающую роль, поскольку они обеспечивают удобный доступ к ключевым разделам, ресурсам или внешним ссылкам, имеющим отношение к проекту. Они действуют как средства навигации, позволяя читателям быстро переходить к определенным частям README без необходимости длительной прокрутки или поиска. Чтобы улучшить доступность, я добавил быстрые ссылки для каждой основной главы в README.< /п>

Возможности и описание

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

Документация по архитектуре

Впоследствии README углубляется в описание документации по архитектуре и включает следующие главы:

* Требования к архитектуре программного обеспечения * Представления архитектуры программного обеспечения * Инструменты, библиотеки и Языки программирования * Лицензии

Для получения более подробной информации обратитесь к соответствующему разделу раздел.< /п>

Стиль кода и документация

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

Если вам потребуется дополнительная информация, посетите раздел, посвященный Стилю кода и Документации.

Статус реализации

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

• Выполнено. В этом столбце указывается, было ли требование реализовано (да или нет).
• Идентификатор функции: служит идентификатором функций проекта.
• Компонент: в этом поле указывается имя соответствующего компонента.
• Имена файлов. Здесь перечислены имена файлов, в которых может быть расположена реализация, относящаяся к требованию.
• Описание. В этом столбце приводится описательное описание функциональных требований.

Вносите свой вклад и оставайтесь на связи

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

Определения, сокращения, сокращения

Наконец, я привожу объяснение Определений, сокращений и сокращений. Этот раздел, представленный в табличном формате, состоит из следующих столбцов:

• Число
• Сокращение или акроним
• Определение

Отслеживание статуса проекта

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

Проекты GitHub

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

ПроектLibre

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

Несмотря на свой статус компактного и бесплатного приложения, ProjectLibre прекрасно предоставил все необходимое для моих нужд.

Выпуск кода и документации

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

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

При соблюдении этого подхода генерируются следующие артефакты:

• Документация по коду, структурированная на основе вспомогательных комментариев.
• Установочные пакеты для последних версий Windows, Mac и Linux.