Как написать руководство ~ Инструкции на все случаи жизни

Показывать буду на примере игры Terraria.

Вначале заходим в библиотеку Steam. Выбираем игру из списка и справа находим кнопку «Руководства и советы» нажимаем на неё.

Нас перекидывает во вкладку руководства нажимаем кнопку «Написать руководство»

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

Далее добавляете разделы и картинки которые вы будете использовать.

Нажимаем на кнопку «Редактировать руководство».

Теперь вводим название и пишем всё информацию.

Когда вы закончите листаете вниз страницы и нажимаете кнопку «Предпросмотр».

Вы попадаете на страницу предпросмотра если вас всё устраивает нажимаете кнопку «Опубликовать руководство».

Больше нечего делать не надо по желанию можете отредактировать его.

Надеюсь вам понравилось.

Дубликаты не найдены

Дальше будут гайды о том, как делать гайды на пикабу для гайда на стим.

А про что ещё гайды делать?

иногда лучше не делать гайды

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

сцук, я то уж подумал будет гайд как «уделать руководителей стим» на примере terraria ))

Нет. Ну серьёзно. Если разжёвывать, как делать руководства, то что от них можно ожидать?

Габен я ушел в ориджин, я не вернусь смирись

Ох уж эти 28 таблеток в упаковке препарата

Хороший тамада и конкурсы интересные

Толерантный расизм

Жена старше меня на 5 лет. История знакомства

Познакомился со своей будущей женой в вагоне-купе поезда. Сначала мы ехали втроём: я, бабуля тучно комплекции и симпатичная девушка. Отбытие вечером. Бабуля всю ночь переворачивалась с бока на бок, хлопала дверями, шастала. А часа в три ночи устроила скандал с проводниками. Ругалась громко на то, что у них жёсткая постель. Ей поменяли матрац. Не устроило.

Мы ехали не в сезон, поэтому многие купе в вагоне были свободными. Бабуля добилась, чтобы её перевели в свободный вагон. Мы остались вдвоём.

Весь этот дурдом с переездом бабули длился где-то до полпятого. Только всё закончилось — легли спать. Проснулся я чуть раньше. Сходил за кипятком — сделал чай. Пью чаёк — в окно смотрю. Девушка проснулась. Ближе к обеду и она решила чай попить. Стала искать кошелёк. Собралась на станции выйти — поесть купить. Всё перерыла — кошелька не было. Она позвонила кому-то. Смотрю, глаза на мокром месте. Оказывается, что кошелёк с деньгами забыла дома. Достала печенье из рюкзака. И молча пила чай. Потом вроде успокоилась. Я предложил ей немного денег. Договорились на том, что вернёт сразу как только сможет.

Остаток пути я на двоих покупал еду. Она же из скромности ела очень мало. Обменялись телефонами. Приехали в Питер. Конечная. Распрощались. Потом начались обычные будни: учёба и работа. Вдруг посреди недели звонок. Та самая девушка. Встретились в кафе. Она вернула деньги и предложила накормить ужином. Мол, я же её угощал — теперь её очередь.

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

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

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

Уже заканчивал универ, у меня начались проблемы с деньгами (на работе начались задержки с оплатой). У моей любимой на работе тоже какие-то махинации со сменой формы собственности… Короче, денег хватало только на оплату аренды и на проезд. Вечер. Из еды остались макароны, лук. Всё, есть больше нечего.

Девушка отварила макарон, я сделал поджарку из лука, сахара, соли и душистого молотого перца. Ели макароны с жареным луком. Так вкусно было…

Уже семнадцать лет прошло с тех пор. А мы с женой до сих пор иногда готовим макароны с жареным луком. Вспоминаем старое )))

Здравствуйте, уважаемые читатели блога: My-busines.ru. Из содержания предлагаемой вашему вниманию статьи вы сможете узнать о том, что такое мануал.

Что это такое

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

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

Для чего нужен

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

Формат

Наиболее распространенными являются следующие форматы: PDF, Word, HTML. Рассмотрим каждую из этих разновидностей форматов более подробно.

PDF-формат наиболее распространен, потому как он является межплатформенным. Изначально данный формат был создан фирмой Adobe Systems с использованием специального языка PostScript. Наиболее подходящей программой для открытия данного формата является Adobe Reader.

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

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

Как составить (написать, сделать) мануал

Написание грамотного мануала включает в себя следующие этапы:

Указание темы. В границах и сфере темы необходимо быть предельно внимательным и точным;
Определение аудитории, для которой составляется (новички, профессионалы, люди со средними знаниями, будут ли изучать самостоятельно или же коллективно);
Выбор количества разделов;
Выбор названий разделов;
Выбор логической структуры изложения материала. Взаимосвязь разделов должна определяться исходя из последовательности действий;
Составление словаря терминов, если планируется использование специальных жаргонизмов. Его необходимо будет обновлять по мере написания;
Определение тем, которые требуют дополнительного исследования. Если вы не уделите подготовке мануала должного внимания, то от него не будет абсолютно никакой пользы. По этой причине очень важно закончить проведение различного рода дополнительных исследований до того, как вы приступите к написанию;
Определение структуры каждого из разделов;
Организация логической последовательности каждой секции и каждого раздела, постепенно сужая границы темы.

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

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

Изображения обязательно должны быть подогнаны под размеры текста.

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

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

Проверять готовый мануал лучше всего в следующей последовательности:

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

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

Маркетолог, вебмастер, блогер с 2011 года. Люблю WordPress, Email маркетинг, Camtasia Studio, партнерские программы)) Создаю сайты и лендинги под ключ НЕДОРОГО. Обучаю созданию и продвижению (SEO) сайтов в поисковых системах.

Содержание статьи:

Краткий видео-обзор статьи:

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

Инструкция — это некие указания, правила и порядок действия, для достижения какой-либо цели. Таких статей в сети Интернет тысячи и все они несут некую полезную информацию.

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

Для чего нужна любая инструкция

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

С точки зрения читателя — это решение его проблемы, в том или ином вопросе, в зависимости от тематики сайта, на котором она опубликована;
С точки зрения заказчика (владельца сайта) — привлечения целевого трафика, а как следствие потенциальных клиентов;
С точки зрения копирайтера — написание качественного текста, который принесет доход или упорядочит информацию в голове.

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

Какие бывают инструкции

Четких критериев и определений на то, какие бывают инструкции, вряд ли кто-то сможет дать. Это сугубо индивидуальная тематика и даже для решения одного и того же вопроса, инструкция может быть совершенно разной и подана в разных стилях, в зависимости от места размещения и контекста.

Но некоторой классификации, в общих чертах, инструкции всеже можно подвергнуть, и так какие виды инструкций бывают:

Инструкция по строительству или сборке чего-либо;
Инструкция по применению чего-либо;
Медицинская инструкция;
Инструкция из разряда «Как сделать…»;
Инструкция по приготовлению пиши (рецепт);

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

Существует отдельный вид инструкций, я его называю «специфический», к нему можно отнести:

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

И аналогичные этому.

Как написать пошаговую инструкцию (самое интересное)

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

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

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

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

Вы пришли сюда из поиска? Это доказывает вышесказанное.

Как написать инструкцию: пример

Как я уже говорил выше, пример написания инструкции — это вся эта статья. Более того, большинство статей на этом сайте, которые начинаются со слова «Как» — являются инструкциями, в той или иной степени.

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

Человек иногда входит в ступор, когда возникает слишком много незавершённых дел.

Но его активная жизнедеятельность не позволяет пустить все на самотек.

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

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

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

С чего начать, чтобы впоследствии меньше допустить ошибок?

Какой хороший вопрос! И очень важная мысль в пояснении к вопросу: не правильно свою жизнь пускать на самотёк. А с другой стороны — планирование будущего — дело неблагодарное.

Написать план действий на ближайшее будущее — без проблем! Ну не все получится, но направление обозначено.

Даже поставить пару — тройку долгосрочных целей — и то каждому под силу и в 16 и в 30 и в 50 лет.

Написать свои желания и мечты — легко!

А руководство к жизни, точнее жизнью. Оно предполагает внесение изменений, учет жизненных обстоятельств в конкретный момент. Это почти план, только динамичный и бессрочный, универсальный. И в этом и состоит вся трудность. Нет, я бы такое руководство не написала бы ни в 20 лет, ни в 30 лет. А сейчас, почти в 45 — наверное, написала бы. Это я еще не поздно «созрела». Еще может лет 30-40 у меня в запасе. Когда стало ясно какой надо быть, как строить отношения, как делать выбор, как принимать решения. А многие и до старости живут ни к чему не стремясь и своею жизнью не управляя.

Руководство жизнью предполагает целью саму жизнь. А цели можно ставить и достигать. Важно понимать, что жизнь длинная, она редко бывает подчинена одной цели. Искусство достигать цели, ставить новые, менять цели, отказываться от одних в пользу других — вот это все начинаешь понимать только с возрастом и жизненным опытом. Мне кажется, в молодости никто почти руководство своей жизнью не напишет. А если напишет, то лет в 60 будет искренне смеяться над собой.

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

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

Да что там таблетки и техника! Зайдите в простой супермаркет, возьмите в руки упаковку с макаронными изделиями. Что вы увидите на обратной стороне? Не своеобразную ли инструкцию по использованию?!

Вот здесь и начинается все самое интересное…

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

Удобство и простота использования товара всегда являлись весомыми «рычагами» влияния на принятие ЦА решения о покупке.

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

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

Написание качественного руководства по эксплуатации товара — это целое искусство. Давайте приоткроем занавес и заглянем «за кулисы» его создания.

Итак, на что же стоит обратить внимание при составлении руководства по эксплуатации, которое будет «работать» на продажи?

Детализация

Конкретика и степень детализации — те параметры, которые определяются согласно уровню подготовленности ЦА. Здесь выбирается оптимальный баланс, ориентированный на потенциального покупателя.

После нажатия ____ появляется приветственное окно.

После нажатия ____ в ____ углу клавиатуры на экране появляется приветственное окно с надписью «____».

Чаще всего встречаются инструкции, содержащие в себе более детальную информацию. Но будьте осторожны! Не стоит доводить детализацию до абсурдности и чрезмерности, иначе вы рискуете разозлить и потерять клиента:

После нажатия пальцем клавиши ____ в правом верхнем углу клавиатуры на экране появляется приветственное окно с темно-синей надписью «____», расположенной посередине.

Структурирование

Мы неоднократно рассказывали о важности структурирования информации в текстах. Такая подача облегчает восприятие материала аудиторией. Не является исключением и руководство по эксплуатации.

Вставьте диск в дисковод.
В появившемся окне нажмите ____.
Выберите пункт меню ____.

Вставьте диск в дисковод, затем в появившемся окне нажмите ____, и уже после этого выберите пункт меню ____.

В первом варианте мы видим пошаговое структурирование информации. Четко, легко и понятно. Иначе выглядит и воспринимается второй вариант — он более «тяжеловесный».

Позитив и корректность

Думаете, это не важно? Ошибаетесь! Для позитивного результата нужно мыслить позитивно и говорить позитивно посредством текста с ЦА (да простят нас ярые противники тавтологии).

Никто не любит хамства и унылости. Поэтому настраивайте деликатно и очень корректно потенциальных покупателей ТОЛЬКО на позитив.

Вот как это выглядит на практике:

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

Достаньте монитор из коробки и освободите от упаковки. Постарайтесь в процессе его не уронить и не разбить.

НЕТ трем «С»: сокращениям, синонимам и сомнениям

При составлении инструкции по использованию товара желательно избегать любой «интонационной неуверенности». Смело вычеркивайте различные «пожалуй, наверное, возможно».

Сокращения допустимы лишь в том случае, если в самом начале руководства была приведена полная формулировка, возле которой указывалась ее «сжатая форма»:

Транспортная компания (ТК) отвечает ____.

Многофункциональное устройство (МФУ) работает ____.

Операционная система (ОС) запускается ____.

Неприемлемо использование синонимов и жаргонов. Не нужно «красоваться» своей эрудицией и запутывать пользователей разной терминологией.

Если речь идет, например, о мобильном телефоне, то не стоит применять по тексту инструкции такие слова, как «мобильник», «мобила», «телефонный аппарат», «сотовый телефон» и т.д.

Мелькают частые повторения? Но вы ведь не художественное произведение создаете, а руководство по эксплуатации. Клиент должен его понять, а не оценить ваш слог и словарный запас.

Да здравствует повелительное наклонение!

Используйте повелительное наклонение — побуждайте пользователей к действию (призывайте, советуйте, предупреждайте, запрещайте).

Для включения телефона нужно нажать на ____.

Кнопка ____ отвечает за включение телефона.

Нажмите ____, чтобы включить телефон.

Включите телефон с помощью кнопки ____.

Последний штрих

Хуже всего, если человек ввиду «путаного руководства» не смог понять, как пользоваться товаром, и отказался от его приобретения. Поэтому…

После того, как готовая инструкция закрепилась на «экранном листе» монитора нажатием кнопки «сохранить», не лишним будет проверить — понятна ли она вашей ЦА.

Мы не занимаемся написанием «словесных полотен» с простым описанием ряда необходимых действий, а разрабатываем четкие, логичные и наглядные руководства.

Руководства по использованию, которые стимулируют пользователей к покупке.

Гайд – это инструкция, руководство, эдакий план действий. В нем описывается порядок действий для достижения конкретного результата. Соответственно, он должен быть максимально понятен и полезен рецепиенту.

В этой статье я рассмотрю, по каким принципам нужно составлять гайд и каких требований придерживаться.

Требования к гайду

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

Четкий алгоритм. Вообще, гайды можно использовать не везде. Лучше всего они подойдут там, где процесс идет по каким-либо этапам. В идеале должен получиться пошаговый «рецепт». Каждый шаг, конечно же, включает только одно простое действие.
Описание конкретного результата. Нужно точно представлять или хотя бы понимать, чего именно хочет достичь человек после прочтения вашего гайда. Основываясь на этих знаниях, вы даете точное направление «развитию сюжета».
Строго по факту. Фраза «без воды» никогда не была столь актуальной… Люди хотят решить свою проблему, и им не всегда нужны какие-либо философские рассуждения или углубления в прилегающую сферу. Просто путь из точки А в точку Б, грубо говоря. В крайнем случае можете дать ссылку на другой источник, где подробнее описываются детали какого-либо этапа.
Соответствие уровню знаний читателя. Когда вы садитесь писать материал, то четко представляете, для кого именно он предназначен. Важен четкий образ: это может быть чайник, который решил освоить что-то новое, профи, пожилой человек, школьник и так далее. Отсюда следует, что чем меньше уровень осведомленности аудитории в затрагиваемой сфере, тем подробнее инструкции. А ежели вы не знаете, кому пишете, и делаете это просто для галочки, то просто тратите свое время и время читателей.
Наличие иллюстраций. Будет не лишним, если весь процесс будет сопровождаться изображениями. Ежели это какая-то инструкция по компьютерам, то это скриншоты. Рецепт? Тогда фотографию процесса приготовления. Где-то может понадобиться видео, где-то и текст вообще ни к чему. Но если используете чужие картинки, не забывайте про авторские права.

Тут ведь еще важно не переборщить, не начать перечислять каждую мелочь или очевидные детали, дабы материал казался объемнее (или по другим причинам). Вставлять картинки ради забавы или красоты в гайдах не стоит. Вряд ли читателю понадобится какой-то мем или фото забавного котика.

Отличия гайда от обзора

Обзор – это рассмотрение самого продукта, его характеристик и каких-то качеств. А гайд – это инструкция по использованию с четко обозначенными действиями. Для описания сути обзора больше подходит слово «Что», а для гайда – «Как».

Как правильно написать гайд

При написании инструкции нужно придерживаться нескольких принципов. С их помощью вы сделаете материал максимально полезным и поймете, кому он вообще нужен.

Определение аудитории

Если вы пишете гайд для крупного ресурса, ориентируйтесь на его «стратегию». Посмотрите, какие материалы на нем публикуются и какие темы затрагиваются, как другие авторы объясняют пользователям те или иные детали. Отталкивайтесь от этого.

Другой вариант – спросите у читателей или клиентов. Будучи экспертом, вы с легкостью сможете определить их уровень знаний. Кстати, таким способом можно еще и определить, в каком стиле лучше излагать мысли.

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

Оптимальный объем

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

Личный опыт

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

Структура и оформление

Четкая последовательность действий, никаких неожиданностей и резких поворотов. Придерживайтесь пошагового принципа и старайтесь не уходить от него.

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

Краткое описание.
Когда нужно использовать инструкцию.
Описание работы по шагам.

Помните про обозначение шагов. Обозначайте разделы разными заголовками. Не делайте слишком длинные абзацы – оптимальный размер составляет от 3 до 7 строк.

Хотите что-то сравнить? Вставьте таблицу. Привязывайте к каким-то элементам полезные ссылки. Используйте списки, если идет перечисление, и не забывайте оформлять их маркерами или номерами.

Объяснения

Если вы в гайде что-то запрещаете, обоснуйте, дайте причины и разъяснения. Пользователь должен понять, по какой именно причине указанное действие недопустимо. Такое вполне можно отобразить в виде картинки, перечеркнутой красной линией или обозначенной словом «Неправильно».

Тест-драйв

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

Проверка

Если у вас нет редактора, проверять текст придется самостоятельно. Рекомендуется после написания отойти на некоторое время от текста, отвлечься, и на «свежую голову» перечитать материал. Полезно еще читать вслух – так вы поймете, не осталось ли спорных моментов.

После завершения вычитки проверьте текст в различных онлайн-сервисах. Первый пункт проверки – это антиплагиат. Вам поможет Text.ru, Etxt или Advego. Второй – грамотность. Здесь вам в помощь Главред, Орфограммка и ОРФО. Третий, если вы размещаете гайд на сайте и ориентируетесь на SEO, – это водность и тошнота текста.

Заключение

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

Как создать руководство в Steam для игры или программы? Вы можете написать собственный гайд по любому приложению вашей библиотеки – и поделиться готовым продуктом с другими пользователями. Давно хотели, но не успели научиться? Самое время приступить сейчас!

Что нужно делать: этапы

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

Первый этап – поиск нужного центра сообщества, он есть у каждой игры. Это делается следующим образом:

Откройте вкладку «Сообщество» на верхней панели;
Введите название игры в поисковую строку и выберите нужный результат из выдачи.

Этот способ отлично работает в десктопном и веб-клиенте. Также в настольном приложении можно сделать так:

Войдите в свою библиотеку через соответствующую иконку на верхней панели;
Найдите в списке слева игру, нажмите на название – на экране справа появится кнопка «Центр сообщества».

Переходим ко второму этапу ответа на вопрос, как создать руководство Стим! На открывшейся странице ищем вкладку с одноименным названием и кликаем по ней.

Там лежат гайды, написанные другими пользователями.

На панели справа вы увидите кнопку «Написать» , позволяющую создать свой продукт;

Сначала введите название в соответствующее поле;
Выберите и загрузите логотип (квадратная картинка, 195х195 пикселей), отражающий тематику контента. Будет отображаться в результатах поиска рядом с названием;
Заполните поле «Описание» подробной информацией;

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

Поставьте галочку в разделе «Права и авторство» , нажмите «Сохранить и продолжить».

Пока вы не поняли, как сделать руководство в Steam — мы смогли создать только обложку, оболочку. Пора наполнить ее содержимым – переходим к следующему открывшемуся окну редактирования.

С помощью кнопки «Добавить раздел» можно создать несколько (не ограничено) разных разделов. Позже можно поменять их порядок, редактировать и удалять;
Все разделы попадут в содержание – оно находится справа, служит для быстрой навигации по странице;
Рядом есть иконка «Добавить автора» . Вы можете внести любого пользователя из списка друзей в соавторы – они также смогут редактировать руководство;
В каждом разделе нужно добавить текстовое описание, с помощью соответствующих иконок загрузить фото/ изображение или видео.

Как написать руководство в Steam – понятно! Пока перед вами черновой вариант, видимый исключительно создателю. Пора раскрыть готовый продукт другим пользователям, похвастаться трудами. Жмите на зеленый значок «Опубликовать»!

Теперь вы сможете создать своё руководство в Стим – постарайтесь добавлять только полезную и интересную информацию. Только представьте, скольких пользователей вы сможете снабдить нужными данными!

Ирина Лощилина

Консультант ГК «Современные технологии управления»

В данной статье описывается подход к разработке Руководства по качеству. Статья рассчитана на специалистов в области качества и .

Возможно, читателю слово «конституция» в заголовке покажется чересчур помпезным. Тем не менее, оно четко указывает на основополагающую роль Руководства по качеству для системы менеджмента качества (СМК). От содержания этого документа зависит, будет ли СМК действительно полезным оружием в конкурентной борьбе, либо станет «чемоданом без ручки», который и тащить неудобно, и бросить нельзя. Вот почему специалисты по качеству тратят немало усилий, чтобы этот документ появился на свет.

Руководства по качеству, как и Конституции, бывают разными. Все зависит от целей, для которых этот документ разрабатывается. В организациях это описание документированных процедур СМК. решает представить Руководство в виде сборника всей документации СМК. В других организациях Руководство по качеству предназначено для обозначения структуры СМК.

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

Для обеспечения эффективности любого руководства важно, чтобы оно сочетало в себе полноту охвата с понятностью и было удобным в использовании. Поэтому Руководство по качеству должно включать в себя всю основную информацию о СМК компании и, при необходимости, ссылки на дополнительные документы. Понятность и простота изложения позволят использовать Руководство не только специалистам в области качества, но и остальным сотрудникам организации. А удобство в использовании даст гарантию того, что сотрудники чаще будут пользоваться именно этим документом, вместо того, чтобы искать решения самостоятельно или через своих коллег.

Полнота

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

За реализацию требований стандарта должны быть назначены ответственные. Следовательно, этих должностных лиц указываем в Руководстве по качеству при описании соответствующего требования. Это могут быть владельцы процессов или должностные лица, ответственные за деятельность, которая описана в документированных процедурах.

Понятность

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

Удобство пользования

Даже на самом мощном автомобиле нельзя будет далеко уехать, если его руль разместить в багажнике. А перегрузка приборной панели различными второстепенными датчиками приведет к тому, что водитель станет отвлекаться от дороги для чтения их показателей. В применении к Руководству по качеству рекомендация по эргономике звучит таким образом: Руководство является основным документом, предоставляющим информацию о требованиях стандарта, в соответствии с которым построена СМК, об использующихся в организации процессах, их взаимосвязи друг с другом и с целями в области качества — все частные положения и регламенты должны быть вынесены в отдельные документы.

Иными словами, Руководство по качеству будет содержать ссылки на описание взаимодействия процессов и на документированные процедуры. Обратите внимание — именно ссылки! Руководство по качеству — это достаточно объемный документ. Не стоит перегружать его подробными инструкциями. Кроме того, каждый конкретный процесс может быть изменен или доработан. Выпуск его регламента в виде отдельного документа во многих случаях позволит ограничиться только его заменой, не затрагивающей все Руководство по Качеству. Использование ссылок приводит нас еще к одной идее — гипертекстовой форме Руководства. Издайте комплекта документации СМК, и популярность вашего внутреннего портала среди сотрудников превзойдет популярность развлекательных сайтов.

Рис. 1. Взаимодействие объектов системы менеджмента качества

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

Связи основных объектов СМК, которые фиксируются в Руководстве по качеству, можно представить в виде диаграммы (рис. 1). Они достаточно прозрачны и просты. Проблему всегда представляет то, что объем этих связей и вспомогательной информации очень велик, и поэтому высоки риски допустить ошибки или вовремя не обновить текст документа. Решить эту проблему можно за счет использования специализированных программных продуктов, которые позволяют автоматизировать процесс разработки Руководства по качеству. Современные программные средства для создания и поддержки СМК не только значительно облегчают и ускоряют ее проектирование, но и позволяют автоматически сформировать всю необходимую регламентирующую документацию на основе взаимодействия объектов СМК. Поэтому теперь разработка Руководства по качеству для специалистов уже не представляет серьезных проблем.

Опубликовано по материалам:
Журнал «Методы менеджмента качества», № 12 2008