Гайд — инструкция по достижению какой либо цели. Она обязана быть понятной.

Если вы написали программу, то есть следующие цели.

1. Вы не хотите объяснять как это работает.
2. Вы хотите похвастаться.
3. Мы не хотим тратить время на понимания всякой фигни, а просто использовать её.
4. Мы хотим понять как это работает, чтобы придумать что-то своё.

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

Шаблон для "будем использовать".

Скрытый текст

1. Название шапки.
   • Должно отражать суть программы, в двух словах.
   • Пример: [Опенкомп] Автокрафт фигни из витчери
2. Команда установки "pastebin run e1khTKYb"
   • Обязательно напишите что это команда и добавьте ссылку отдельно для более опытных.
3. Команды программы.
   • Гайд управления программой должен быть в самой программе. Если для работы с вашей программой надо искать гайд, на админом забытом форуме, то вы плохо сделали программу. Добавьте хотя бы команду help.
4. Схема сборки внешних компонентов, под спойлером.
   • Схема это картинка сборки с описанием блоков под ней.
   • Описание блоков это название блока и его ид. Никаких почему и зачем он там стоит быть не должно.
5. Ваш гайд по объёму должен занимать размер статуса.
   • Если у вас получилось что-то больше, я вас поздравляю, у вас получился шлак. Готовьтесь ловить дизлайки.

Шаблон для "будем понимать".

Скрытый текст

1. Название заголовка.
   • Должно совпадать с названием приёма.
   • Пример: [Опенкомп] циклы
2. Сам приём в чистом виде.
3. Объяснение приёма.
4. Пример приёма.
   • Можете дать ссылку на успешный гайд типа "будем использовать", указав где именно этот приём применён.
5. Размер этого гайда должен занимать не более монитора 1080.
   • Если будет больше, вашу кашу даже читать не будут. Готовьтесь ловить дизлайки.
6. Не пытайтесь уместить два и более приёма в один гайд.
   • Это сложно для вас и читающих.