Добавляет рецепт «Как написать README на GitHub» (#4728)

* Добавляет рецепт «Как написать README на GitHub»

* Добавляет рецепт в индекс

* Принимает правки @TatianaFokina

Co-authored-by: Tatiana Fokina <fokinatatian@gmail.com>

* Принимает правки @skorobaeus

Co-authored-by: Svetlana Korobtseva <wizzzjer@gmail.com>

---------

Co-authored-by: Tatiana Fokina <fokinatatian@gmail.com>
Co-authored-by: Svetlana Korobtseva <wizzzjer@gmail.com>

recipes/github-add-readme/index.md

@@ -0,0 +1,50 @@
+---
+title: "Как написать README на GitHub"
+description: "Опишите свой продукт на GitHub правильно."
+authors:
+  - igsekor
+related:
+  - tools/version-control
+  - tools/git-cli
+  - tools/github-actions
+tags:
+  - article
+---
+
+## Задача
+
+Добавить базовое описание репозитория продукта на GitHub.
+
+## Решение
+
+Файл _README.md_ в корневой папке репозитория — особенный файл для любого продукта. В нём, как правило, даны самые основные сведения о репозитории:
+
+- название продукта;
+- краткое описание;
+- основные возможности;
+- инструкция по установке и/или подключению;
+- инструкция по запуску в режиме разработчика и в режиме пользователя;
+- список участников репозитория, которые разрабатывают и поддерживают продукт.
+
+Написать хорошее описание продукта непросто, и это требует определённого навыка. Хорошей идеей будет посмотреть, как это делают коллеги. В каждом продукте есть и что-то схожее с остальными, и по-своему уникальное. Важно правильно расставить акценты. Помните, что _README.md_ — обложка вашего проекта.
+
+Потребителями _README.md_, скорее всего, будут разработчики и продвинутые пользователи, например, администраторы систем. Язык программирования, выбранные задачи репозитория, принятые в сообществе нормы описания будут определять содержимое файла. Хорошее описание поможет продвинуть продукт. Его легче будет найти на GitHub и в поиске, а ещё им будет комфортнее пользоваться. Хорошее описание привлекает хороших разработчиков.
+
+В _README.md_, в первую очередь, ответьте на следующие вопросы:
+
+1. **Почему был создан продукт?** В ответе на этот вопрос можно опираться на такие понятия как мотивация, история, потребности, мечты и прочее.
+1. **Для чего был создан продукт?** Здесь лучше всего описать те проблемы и потребности, которые закрывает продукт.
+1. **Чем продукт лучше аналогов?** Если у продукта есть аналоги, необходимо написать об отличиях и особенностях продукта.
+1. **Как установить продукт?** Тут необходимо написать краткую инструкцию по установке.
+1. **Как пользоваться продуктом?** Тут нужно написать краткую инструкцию пользователя из серии «Быстрый запуск».
+1. **Как помочь продукту развиваться?** Здесь лучше ответить тем разработчикам, которые хотят поучаствовать в развитии продукта.
+1. **Кто разрабатывает продукт?** Самый простой ответ на этот вопрос — список разработчиков, но может быть и описание компании или инициативы, в рамках которой продукт был создан или развивается.
+
+В _README.md_ используется разметка в [формате Markdown](/tools/markdown/). Структурируйте текст файла, выделяя каждый блок заголовками и подзаголовками. В интерфейсе GitHub заголовки хорошо выделяются на фоне текста до третьего уровня, поэтому старайтесь использовать заголовки первого и второго уровня. Возможная структура _README.md_:
+
+- **название** (заголовок первого уровня) — название продукта без указания версии, если в этом нет особенной необходимости, например, из-за лицензии;
+- **описание** (заголовок второго уровня) — краткое описание продукта, в котором можно ответить на вопросы 1, 2 и 3 из списка вопросов выше;
+- **установка** (заголовок второго уровня) — описание процесса установки продукта (вопрос 4);
+- **использование** (заголовок второго уровня) — описание процесса использования продукта (вопрос 5);
+- **разработка** (заголовок второго уровня) — описание процесса того, как принять участие в разработке проекта или запрет на это (вопрос 6);
+- **участники** (заголовок второго уровня) — перечисление всех, кто принимал или принимает участие в разработке продукта (вопрос 7).

recipes/index.md

@@ -23,6 +23,7 @@ groups:
       - github-choose-license
       - github-add-user-to-repo
       - github-new-pull-request
+      - github-add-readme
   - name: 'Рутина'
     items:
       - font-script