docs: update docs

Author: alexeev-prog

CHANGELOG.md

@@ -1,3 +1,15 @@
+commit e0dc361414ba20087978848081e6228016f708a8
+Author: alexeev-dev <[email protected]>
+Date:   Fri Oct 4 21:53:36 2024 +0700
+
+    docs: update docs
+
+commit 3a44d6838e6f0b6a1f0aa3d8cf07e79fd548c7a1
+Author: alexeev-dev <[email protected]>
+Date:   Fri Oct 4 21:53:23 2024 +0700
+
+    build.sh
+
 commit 3e4247c67c65e74dfe6b14e3d74acf209ccf8cd2
 Author: alexeev-dev <[email protected]>
 Date:   Fri Oct 4 21:50:44 2024 +0700

docs/ru/article3.md

@@ -24,13 +24,10 @@
 # Внешний вид библиотеки
 Человека встречают по одежке, а open source проект - по его описанию, README. Для того, чтобы пользователь мог понять, что к чему, следует в описании отвечать на следующие вопросы:
 
-Какое назначение проекта? Описание должно быть лаконичным и отражающим суть проекта.
-
-Почему проект полезен? Он должен решать определенные проблемы, поэтому необходимо явно написать о них, чтобы потенциальный пользователь мог понять, будет ли библиотека полезной для него. Нужно выделить преимущества своего решения по сравнению с аналогами, желательно с конкретными цифрами и бенчмарками, иначе потенциальный пользователь установит более эффективную или популярную библиотеку.
-
-Как приступить к работе с библиотекой? Этап с установкой и настройкой библиотеки необходимо описать самым детальным образом. Ведь далеко не всегда то, что очевидно вам — очевидно другим. Решением могут пользоваться люди, у которых совершенно другой опыт. Нужно, чтобы любой желающий, кто хочет установить решение, понял, как это сделать.
-
-Где можно получить дополнительную помощь, если она мне понадобится? Обязательно оставить свои контакты или другую предпочитаемую форму взаимодействия.
+1. Какое назначение проекта? Описание должно быть лаконичным и отражающим суть проекта.
+2. Почему проект полезен? Он должен решать определенные проблемы, поэтому необходимо явно написать о них, чтобы потенциальный пользователь мог понять, будет ли библиотека полезной для него. Нужно выделить преимущества своего решения по сравнению с аналогами, желательно с конкретными цифрами и бенчмарками, иначе потенциальный пользователь установит более эффективную или популярную библиотеку.
+3. Как приступить к работе с библиотекой? Этап с установкой и настройкой библиотеки необходимо описать самым детальным образом. Ведь далеко не всегда то, что очевидно вам — очевидно другим. Решением могут пользоваться люди, у которых совершенно другой опыт. Нужно, чтобы любой желающий, кто хочет установить решение, понял, как это сделать.
+4. Где можно получить дополнительную помощь, если она мне понадобится? Обязательно оставить свои контакты или другую предпочитаемую форму взаимодействия.
 
 Можно использовать свой README для ответа на другие вопросы. Например, дальнейшие цели в развитии проекта, информация о лицензиях, важных изменениях в коде.