Что такое туториалы

[octobot]

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

Чтобы туториал был максимально полезным и информативным, он должен соответствовать определенным требованиям:

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

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

Наличие иллюстраций
Весь процесс должен сопровождаться изображениями. Где-то может понадобиться видео или даже гифка.

Целесообразность
Стоит ли это отдельного руководства? Если для объяснения рассматриваемой вещи не требуется целый туториал, то лучше воздержаться от написания.

---