Translate

This commit is contained in:
Alexander Ivanov
2019-08-25 09:22:21 +03:00
parent bbb6bfda94
commit d5bb5dcc01

View File

@ -0,0 +1,31 @@
# Наш манифест по написанию контента
Как мы улучшаем процесс чтения и обучения для наших посетителей
## 1. Простое лучше, чем лучшее
<br/>
Наша миссия - облегчить чтение и усвоение знаний, мы курируем контент. Таким образом, мы концентрируемся на преобразовании сложных и изнурительных тем в упрощенный список, обмениваем перегруженную информацию сокращенными и менее точными деталями, избегаем "легковоспламеняющихся" и противоречивых тем и избегаем субъективных идей в пользу общепринятых практик.
<br/>
## 2. Быть обоснованным и надежным
<br/>
Наши читатели должны быть уверены, что контент, который они просматривают, надежен. Мы достигаем этого путем включения таких доказательств, как ссылки, данные и другие ресурсы, доступные по этой теме. Практически, старайтесь включать цитаты из надежных источников, показывать контрольные показатели, связанные шаблоны проектирования или любые научные меры, чтобы доказать свои претензии
## 3. ВИСИ (взаимоисключающие и совместноисчерпывающие)
Помимо того, что контент хорошо отредактирован и надежен, его просмотр должен также обеспечить полное освещение темы. Ни одна важная подтема не должна быть исключена
## 4. Согласованное форматирование
Контент представлен с использованием фиксированных шаблонов. Любое будущее содержание должно соответствовать тому же шаблону. Если вы хотите добавить новые маркеры, скопируйте формат маркера из существующего маркера и расширьте его для своих нужд. Для получения дополнительной информации, пожалуйста, просмотрите [этот шаблон](https://github.com/i0natan/nodebestpractices/blob/master/sections/template.md)
## 5. Это про Node.js
Каждый совет должен быть связан непосредственно с Node.js, а не с разработкой программного обеспечения в целом. Когда мы советуем реализовать общий шаблон/правило в Node.js, содержимое должно быть сосредоточено на реализации Node. Например, когда мы советуем очистить все запросы ввода по соображениям безопасности, следует использовать Node-нотацию - "используйте промежуточное ПО для очистки ввода запроса". Если у элемента нет конкретной реализации в Node.js (например, он выглядит одинаково в Python и Jaba) - включите его в общий элемент контейнера, см., например, пункт 6.5
## 6. Только ведущие поставщики
Иногда полезно включать имена поставщиков, которые могут решить определенные задачи и проблемы, такие как пакеты npm, инструменты с открытым исходным кодом или даже коммерческие продукты. Чтобы избежать слишком длинных списков или рекомендовать не заслуживающие доверия и нестабильные проекты, мы разработали следующие правила:
- Рекомендуются только топ-3 поставщиков - в нашу рекомендацию может быть включен поставщик, который появляется в топ-3 результатов поисковой системы (Google или GitHub по популярности) для данного релевантного ключевого слова.
- Если это пакет npm, его также должны скачивать в среднем не менее 750 раз в день
- Если это проект с открытым исходным кодом, он должен быть обновлен хотя бы один раз за последние 6 месяцев