TOP

Составляем туториал

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

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

План туториала

1. Постановка проблемы.
2. Какое решение есть у этой проблемы.
3. Какие шаги надо сделать, чтобы решение заработало:
4. Шаг 1
5. Шаг 2
6. Шаг 3

7. Шаг n

Чем подробнее описываете шаги, тем лучше. Но и перебарщивать не стоит — «чтобы ввести логин, поставьте курсор в поле формы» — уже лишнее.

Как писать

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

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

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

 

Не ок

Как настроить Homebridge

В наше время широко распространены умные устройства. Наверное, в каждом доме есть хоть один смарт-девайс. Они все в целом достаточно дорогие, но те, что несут на своей упаковке значок Homekit — особенно. Они сертифицированны компанией Apple и их не всегда можно найти в российской рознице. Именно поэтому несколько лет назад один гениальный программист решил сделать из Raspberry Pi мост, который смог бы сэкономить вам деньги. То есть стал бы поддерживать работу несертифицированных устройств, например всем известного китайского гиганта Xiaomi.

Ок

Как настроить Homebridge и добавить несертифицированные устройства в умный дом Apple

Homebridge — устройство на базе Raspberry Pi. Оно может подружить Apple Homekit и большинство умных устройств, которые Apple официально не поддерживает.

Вот что вам понадобится:

Raspberry Pi (минимально — Zero W).

Карта памяти от 8 ГБ и выше.

SSH-клиент на смартфоне или компьютере.

Устанавливаем Raspbian

Сначала нужно установить на Raspberry Pi версию Debian — она называется Raspbian…



 
 
 

О чем писать

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