Правила оформления статей

Материал из Minter Wiki
Мв.png

Minter Wiki — это не Википедия с огромным списком правил, но у нас они тоже есть.

Статья должна быть полезной

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

Если это статья о валидаторе — расскажите что это за валидатор. Когда он был запущен, кем поддерживается. Есть ли у валидатора сайт? Канал в телеграме? Свои сервисы, open source решения? Команда валидатора участвовала в хакатоне и победила? Отлично, расскажите об этом тоже. У валидатора есть гибкая система лояльности? Напишите о ней подробно. Любая информация, которая отвечает на вопрос "Что это за валидатор, можно ли ему доверять?" будет полезной.

Если это статья о монете — опишите назначение монеты и ее характеристики. Дайте ссылку на PCO. Напишите хотя бы кратко кто создал монету. Команда? Один человек? Что это за человек, чем он занимается помимо Minter? Есть ли у него социальные профили? Приложите ссылки на сайт команды или, еще лучше, напишите отдельную статью о владельцах монеты.

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

Если это техническая статья — не стесняйтесь вставить пример кода или подробно расписать формулу, по которой считается цена делегированной монеты. Если человек читает статью о математике Minter — ему интересна математика! Если статья об использовании API — значит читатель явно понимает что такое SDK и подробное описание параметров для вызова того или иного метода тоже его не испугает. Minter Wiki нужны и технические статьи.
Общий совет такой — поставьте себя на место человека, который будет читать вашу статью. Вам бы она помогла? Вы бы дочитали ее до конца?

Эй.png

Статья должна быть академической

Академический стиль изложения — не значит скучный.

Даже статья о мемах может быть академической. Академический стиль изложения не значит запредельно сложный и доступный для понимания только людям с IQ > 200. Даже о квантовой физике можно написать так, что ребенку будет интересно. Академический стиль изложения это логичность, последовательность и ясность. Текст должен быть написан осмысленными предложениями, разбитыми на отдельные логические блоки и быть легко читаемым и доступным для понимания.
Академический стиль изложения также подразумевает описание фактов, а не эмоций или личного мнения автора.

Например:

  • "BLACK HOLE — это единственный на данный момент действующий валидатор с комиссией 100%" — это факт.
  • "BLACK HOLE — это нода, которая не заслуживает места в топе и вообще нарушает все правила" — это личное мнение, которое не несет в себе полезной информации.

Статья должны быть грамотной

Это вопрос уважения к читателям и минимальная планка качества.

Ваша статья может не раскрывать тему на 100%, но она должны быть написана без орфографических, пунктуационных и лексических ошибок. Мы живём в 2019 году и многие сервисы умеют подсказывать самые явные ошибки в тексте, не ленитесь проверить ваш текст хотя бы в Google Docs.

Dc.png

Добавляйте иллюстрации

Если это необходимо. Обрежьте ваши картинки и оставьте на них только важную информацию. Иллюстрации должны быть качественными и если они принадлежат не вам — укажите автора.
(Иллюстрация с сайта https://decenter.org)

Прикладывайте ссылки на источники

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

Объём не важен

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

На статьи в Minter WIki распространяются лицензия CC BY 4.0

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

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