БРЕD-политика: правила оформления вопросов и ответов


1. Кодекс поведения

1.1. Будьте вежливы

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


1.2. Обращайтесь на «вы»

Общайтесь с другими пользователями только на «вы».

Некорректно: Неправильно ты, Дядя Фёдор, датчик подключаешь!

Корректно: Дядя Фёдор, подключите датчик, как указано на схеме.


1.3. Не будьте агрессивны

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

Некорректно: Windows ваш — фуфло, поставьте Linux, потом приходите!

Корректно: Похоже, что перепрошивка возможна только из-под Linux. Можете использовать Linux Live USB Flash, если нужно запустить его один раз, а от Windows вы отказаться не готовы.


2. Постановка вопросов

2.1. Заголовок темы — это вопрос или описание проблемы

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

Некорректно: Не пойму, что происходит с датчиком. ПОМОГИТЕ!!1...

Корректно: Датчик DS18B20 не передаёт данные.


2.2. Одна тема — один вопрос

Бывает, что при реализации своих проектов у вас возникает сразу несколько вопросов. Изолируйте проблемы и опубликуйте их отдельными вопросами. Это нужно, чтобы другие участники не запутались в вопросах и могли ответить только на те вопросы, в которых компетентны.

Некорректно: Как подключить моторы и заставить работать сразу несколько дальномеров?

Корректно:
— Как подключить моторы через Motor Shield?
— Как прошить микроконтроллер?


2.3. Не задавайте оценочные вопросы

Вопросы в духе «что лучше: яблоки или апельсины» не имеют единственно верного ответа и слишком субъективны по своей сути. К примеру, каждый пользователь сам решает, какую среду программирования удобнее выбрать, в зависимости от своих целей и возможностей. То же самое и с железом: иногда вопрос «лучше» или «хуже» — всего лишь дело вкуса.

Некорректно: Что лучше: Arduino или ESP32?

Корректно: Какой котроллер можно заставить прожить дольше от одной батарейки: Arduino Nano 328p или ESP32 WROOM DevKit?


2.4. Не задавайте справочные вопросы

Иногда возникают вопросы, которые упираются в тривиальную справочную информацию: например, вам захотелось узнать тип датчика, тактовую частоту процессора или значение числа π с точностью 4 знака после запятой. Все эти данные можно найти в характеристиках и datasheet’ах от производителей. Фактически, для ответа не нужно обладать никакими знаниями — достаточно просто загуглить вопрос.

Некорректно: Сколько аналоговых входов на Arduino Uno?

Корректно: Встроен ли в пин 13 на Arduino Uno токоограничивающий резистор?


2.5. Не задавайте слишком общие вопросы

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

Некорректно: Как на Ардуино сделать радиоуправляемого робота-паука?

Корректно: Как рассчитать углы трёх сервоприводов ноги робота-паука, если известно желаемое положение кончика лапы?


3. Правила ответов

3.1. Отвечайте на вопрос темы

Всегда отвечайте именно на первый пост, где содержится вопрос темы. Не отвечайте на ранее опубликованный ответ в середине треда. У ответов на Бредборде вообще нет строгого порядка: они меняются местами в зависимости от набранных голосов.

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

Некорректно: Но в случае с USB 3.0 минимум — это 0,9 ампер.

Корректно: Как уже сказал @burumburum:
Стандарт USB обязывает предоставлять устройству не менее 0,5 ампер. При этом можно выдавать и больше. Так, например, некоторые зарядники выдают по USB и 1, и 2, и 3 ампера.
Но это справедливо для USB 2.0. В случае с USB 3.0 минимум — это 0,9 ампер.


3.2. Пользуйтесь комментариями для уточнений

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


4. Оформление постов

4.1. Сопровождайте ссылки пояснениями

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

Некорректно: Тут всё написано: https://wiki.abracadabra.gov/instrukcii/raznoe

Корректно: Этот вопрос подробно разбирался на Abracadabra Wiki:

Устройство, скорее всего, подключено к абонентской группе. Просто добавьте своего пользователя в группу dialout, чтобы у вас были соответствующие разрешения на устройстве.

sudo usermod -a -G dialout $USER

Возможно, вам придется выйти из системы и вернуться к ней, чтобы новая группа вступила в силу. Не нужно возиться с разрешениями или правилами udev.


4.2. Упоминайте названия моделей плат и чипов в явном виде

Давая ссылку на какую-либо железку, пропишите в качестве анкора её полное название. «Датчик DS18B20» — формулировка понятная для всех, её можно загуглить, найти альтернативы. Смысл не потеряется, если целевая страница перестанет существовать.

Некорректно: https://abracadabra.gov/datchyki/raznoe/ds18b20

Корректно: Датчик температуры DS18B20


4.3. Не публикуйте реферальные и размеченные ссылки

Если в опубликованной ссылке содержатся реферальные, UTM- и прочие коммерческие метки, редакция оставляет за собой право очистить URL от них или скрыть пост целиком. Преследуя коммерческие цели, вы теряете объективность. А это противоречит целям Бредборда.

Некорректно: Покупайте датчики у проверенного продавца: https://abracadabra.gov?ref_id=12345

Корректно: Датчик можно купить, например, в магазине «Синь-Пинь» (https://abracadabra.gov)


4.4. Встраивайте изображения в пост

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

Некорректно: Есть схема: https://abracadabra.gov/uploads/user/abc/shema-sensora.jpg

Корректно: Есть схема:


4.5. Оформляйте код через сниппеты

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

Некорректно:
String inputString = ""; // a String to hold incoming data
bool stringComplete = false; // whether the string is complete

void setup() {
// initialize serial:
Serial.begin(9600);
// reserve 200 bytes for the inputString:
inputString.reserve(200);
}

Корректно:
String inputString = "";         // a String to hold incoming data
bool stringComplete = false;  // whether the string is complete

void setup() {
  // initialize serial:
  Serial.begin(9600);
  // reserve 200 bytes for the inputString:
  inputString.reserve(200);
}


4.6. Приводите минимальный рабочий пример кода

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

Добро пожаловать на Бредборд! Сайт вопросов и ответов на тему Arduino, Raspberry Pi и хоббийной электроники в целом. Цель Бредборда — быть максимально полезным. Поэтому мы строго следим за соблюдением правил, боремся с холиворами и оффтопиком.
...