Вложений: 8
Руководство по написанию руководств
Руководство по написанию руководств.
На написание этой "инструкции по пользованию инструкциями" меня сподвигла пара творений опубликованных в этом разделе форума в последнее время, на которые что называется "без слез не взглянуть". Еще чуть позже выяснилось, что такое руководство оказывается уже просили. Попробую в меру своих сил восполнить этот пробел.
То что здесь написано, это мое личное мнение. Оно не претендует на абсолютность или истину в последней инстанции. Истина где-то рядом :). Фактически, это моя вольная интерпретация того, как писать научные статьи.
Версия 1.01 от 31 мая 2013.
Оглавление.
- Введение.
- С чего начать.
- Сбор и подготовка информации.
- Пост-обработка.
- Размещение на форуме.
Сначала было слово.
Хотя скорее всего, вначале все-таки был Большой Взрыв. Прежде чем начинать что-то писать, вам предстоит ответить самому себе хотя бы на три вопроса: Что? Зачем? Кому? В любой последовательности.
Итак, вопрос первый: Зачем вы пишите руководство? Какую цель ставите перед собой? Вариантов ответов может быть много: вы хотите поделиться с окружающими своими бесценными знаниями и опытом, чтобы они не наступали на те же грабли что и вы? Или просто решили осветить какой либо момент игры? Или решили поправить свое финансовое положение получив премию за руководство либо выиграв конкурс руководств? А может просто хотите потешить свое тщеславие получить форумную медальку и войти в историю? Вариантов может быть много, и от ответа будет зависеть точка главного фокуса вашего руководства: содержание, оформление, объем, или что-то еще.
Затем вам придется ответить на вопрос: Что же именно вы хотите рассказать в свое руководстве? О чем оно оно будет: Классовое руководство? Как играть в гоблинобол? Как заработать миллион? Что нас ждет в астрале? Сколько ХП у Гога и Магога? Как качественно убить Тэпа? Где взять корм для котенка на Кирахе? Вообще говоря, было бы желание, а тема найдется. Еще на форуме есть тема "Каких руководств вам не хватает?", можно в ней покопаться на предмет идеи.
Третий вопрос, на который вам тоже нужно ответить: Кто является целевой аудиторией руководства? Тут все немного проще чем с целью. Фактически, вашей целевой аудиторией могут быть: i) начинающие игроки, ii) опытные игроки, iii) либо обе эти группы вместе. Есть конечно еще одна целевая группа - администрация :). От ответа на этот вопрос, будет зависеть насколько подробно вам придется описывать те или иные моменты.
На самом деле, все эти три вопроса связаны, и отвечать на них нужно в комплексе. А если вы сумели на их ответить, то теперь задайте себе последний вопрос, о ваших собственных способностях и возможностях. Хватит ли у вас сил и опыта, или лучше не марать бумагу :). Согласитесь, что например классовое руководство от персонажа у которого на юзербаре 5000 попугаев, будет выглядеть по крайней мере странно.
Чукча не читатель, чукча писатель.
Итак если вы определились что будете писать и для кого, то теперь на некоторое время вам предстоит стать читателем. А именно, отправиться в раздел "Каталог руководств", найти там тему "► Каталог руководств (гайдов) ►" (она помечена как важная и наглухо прибита форумными гвоздями вверху раздела). Затем поискать в этом перечне, нет ли там чего-то похожего на то, что вы хотите написать? Не нашли? Тогда придется воспользоваться поиском по форуму, по ключевым слова. Например: "мистик" и "руководство/гайд", или "тайны мира" и "лига/империя". Также можно просто просмотреть заголовки тем в разделе "Каталог руководств".
Если вы хорошо искали и не нашли ничего, похожего на то о чем вы хотите написать, то скорее всего ничего похоже написано еще не было. Значит вперед, клавиатура ждет. Если же вы нашли что-то похоже на то, о чем вы хотите написать, то это еще не значит что все уже написано до вас, и делать вам в этой области больше нечего. Руководство может быть устаревшим, или плохо оформленным, или вы сочтете что какой-то из моментов в нем освещен не достаточно подробно. А может быть вы просто можете сделать лучше. Значит за работу.
Перед тем как приступить к работе, прочитайте несколько руководств из каталога. После чего, запаситесь большим количеством терпения и времени для написания. К слову, написание этого руководства заняло примерно 14 часов.
Если ли у вас план, мистер Фикс?
Дом начинается с проекта, а руководство с плана или примерной разметки. Разбейте главную идею вашего будущего руководства на части: выделите несколько основных моментов, которые вы хотели бы донести до читателей - это будут части (ну или главы) вашего руководства. Запишите несколько слов или фраз, которые характеризовали бы то, что вы хотите сказать. Ваш план может быть не статичным и меняться по мере работы над руководством.
Например для этого руководства, первоначальный план работ выглядел следующим образом:- Что, зачем, кому.
- Есть/нет, надо/нет, разметка и размер.
- Исходники и обработка.
- Оформление/форматирование: текст, картинки, эмоции. Злоупотребления.
- Читабельность.
- Офф-лайн.
Желательно, чтобы в пределах каждой части ваш рассказ оставался однородным, и чтобы каждая часть доносила законченную мысль. Размер глав-мыслей должен быть быть таким, чтобы их чтение и осознание не вызывало сложности у среднего человека. После написания главы проведите простейшую проверку: отвлекитесь на 5 минут, а затем прочитайте всю главу. После этого сходите на кухню, налейте себе чая/кофе/сока/воды, и попытайтесь пересказать самому себе то, что вы причитали. Если вам это удалось, а мысли, возникшие у вас в голове, совпали с первоначальным замыслом - отлично. Если что-то не сходится - то вероятно вам придется дополнить, или может даже совсем переписать главу. Не жалейте текст :).
Будет неплохо, если каждая часть будет читаться на одном дыхании и звучать как маленькая история. Если вам кажется что какая-то глава получается великовата - разбейте ее на 2-3 части. Кроме того не стесняйтесь разделить ваш текст на отдельные абзацы. Во-первых, читать сплошной текст тяжело, а во-вторых он плохо запоминается. Размер абзаца должен быть таким, чтобы к тому моменту как вы закончили его читать, вы еще помнили с чего он начинался. Оптимальная длина абзаца 5-10 предложений. Не используйте сложные конструкции предложений без особой нужды. Старайтесь не использовать избыточно длинные предложения. Если средняя длина вашего предложения такова, что вы сами не можете его прочитать без дополнительной остановки и к середине забыли первое слово или потеряли смысл вообще - то оно избыточно длинное. Вот где-то так :).
Информация и источники.
Если план готов, то самое время соотнести его с имеющейся информацией, которую мы хотим донести до читателей. Если окажется что у вас есть все необходимое - то можно приступать к написанию. Если же окажется что вам чего-то не хватает, то вам придется припасть к истокам и пополнить свои знания. Ну или скорее перелопатить горы пустой породы и добыть из них алмазные крупицы знаний. В крайнем случае сойдет уголь или графит сырых данных, который нам еще предстоит превратить в алмазы.
Источниками информации могут быть:- Игра. Запускаем клиент, заходим в игру и проверяем интересующий нас момент. Если вы по какой-то причине не можете проверить что-то самостоятельно, попросите это сделать кого-то из друзей, согильдийцев или форумчан. Если известно, что какой-то конкретный игровой момент будет в ближайшее время изменен, не забудьте об этом упомянуть. После того как изменение будет внесено очередным обновлением, обновите руководство.
- Сообщения и уточнения официальных лиц на форуме: Allods Team, представителей администрации, КМов. Например, официальные руководства и комментарии к ним, сообщения на новостной ленте.
- Результат дискуссии участников игрового сообщества. Это если вы вдруг решили изучить все обсуждения в теме "Пирамида Тэпа: Обсуждение", собрать все в одно место и написали руководство "Пирамида Тэпа для чайников".
- Ответы службы поддержки. Не все что вам говорит СП можно публиковать, но в некоторых случаях ответы службы поддержки можно использовать.
В любом случае, нужно указать где вы все выкопали, источник получение информации. Если что-либо является вашим собственным выводом или домыслом, не забудьте это упомянуть. Также не забудьте указать версию игрового клиента.
Что не стоит использовать как источники:- ОБС: Одна Бабка Сказал. Т.е. в нашем случае это слухи и/или флейм, на форуме и/или в игре. К слухам относится все, у чего вы не смогли найти проверяемый первоисточник.
- Анонсы грядущих глобальных обновлений и информацию из дневников разработчиков. Все может измениться. Если вы конечно не пишите "Руководство по сбору слухов и прочей предварительной информации". Простейший пример: не стоит писать новое классовое руководство на основе информации "В разработке", даже если вам уже дали бета-калькулятор талантов. Если очень не терпится, то начните писать, а после обновления проверяйте и публикуйте.
Полировка и доводка.
Следующим этапом вашей работы будет творческая обработка добытой информации. В нашем случае это может быть написание непосредственно текста, подготовка картинок или видео, расчеты чего-то полезного, еще что-то... Начинайте с самого начала, точнее с плана, который вы составили. Вам предстоит постепенно расширить каждый его пункт, подробно излагая имеющуюся информацию. Сначала каждое слово плана превратится в абзац, а постепенно каждый пункт - в главу. Ваша цель - нарастить мясо на первоначальный скелет. Как это делать - я не знаю, у каждого свой путь.
Оптимальным вариантом будет писать ваш будущий шедевр офф-лайн, в каком-нибудь текстовом редакторе, а не сразу на форуме. Тут никаких рекомендаций давать не буду. Кто-то любит MS Word или Open Office Writer, кто-то gedit, а кому-то милее всего Notepad, а кто-то может быть фанат Google Docs. В чем нравится, в том и пишите, хотя конечно редактор со встроенной проверки орфографии и автокоррекцией предпочтительней.
Именно эта часть работы над руководством, потребует от вас самых значительных усилий и займет большую часть времени. Если приложенные усилия будут достаточными, то черный уголь сырых идей и данных превратится в алмаз. Чем больше усилий вы приложите - тем больше и качественней он у вас получится.
И солнце ярче светит и радуется глаз.
Предположим что алмазный текст вашего будущего шедевра закончен. Теперь предстоит его тщательно отполировать и превратить в сверкающий бриллиант. Эта часть работы тоже не быстрый и трудоемкий процесс.
Текст.
Начините с проверки орфографии. Можно конечно полностью следовать поговорке "владение орфографией - это как владение кунг-фу, настоящие мастера не применяют его без необходимости". Но с другой стороны, у настоящего мастера все получается естественно и без напряжения. Кроме того, читать текст без ошибок на порядок приятней чем с ними. Так что все-таки стоит проверить свой текст на ашипки.
Для этого есть несколько путей.- Можно воспользоваться встроенной проверкой какого-либо офисного пакета, например Оpen Office или MS Office. Как вариант - использовать Google Docs.
- Вы можете написать письмо самому себе, включил проверку орфографии в e-mail клиенте - как он-лайн, так и офф-лайн.
- Ну и наконец при написании вашего сообщения на форуме. Opera, Firefox и Chrome имеют встроенную проверку орфографии, но возможно вам придется установить русский словарь. В случае с IE вам придется найти и установить плагин для проверки орфографии.
На всякий случай: новое предложение начинается с большой буквы :).
Буква Ё.
В русском письме, простановка точек над "ё" в большинстве случаев факультативна - хотите пишите, хотите нет. Обязательно писать букву "ё" нужно в тех случаях, когда возможно неправильное прочтение слова, например, в именах собственных (с нашем случае в никах). В любом случае старайтесь быть последовательны, если половина одна текста с "ё", а вторая без, то это смотрится не очень красиво.
Точка, точка, запятая.
"Знаки препинания, служащие нотами при чтении, расставлены у Вас, как пуговицы на мундире гоголевского городничего".
А. П. Чехов
Следующий пункт программы - расстановка "знаков препинания".
Задача на самом деле не совсем тривиальная, в простейшем случае нужно хотя бы расставить точки в концах предложений. С запятыми сложнее. Офисные пакеты конечно умеют их расставлять, но делают это не всегда верно. Это текст я пишу в Winedt-е, и тут такой функции нет вообще. Так что если не помните все правила (я например, не помню), а проверка невозможна, то пользуйтесь здравым смыслом.
Еще один важный момент, который очень часто ускользает от внимания писателей: отношения пробелов и знаков препинания.- Перед точкой, запятой, точка с запятой, много- и двоеточием, восклицательным и вопросительным знаками - пробел не ставится.
- После них же и перед началом следующего слова - ставится пробел. Не стоить ставить двойные пробелы между словами, это выглядит некрасиво.
- Скобки и кавычки. Перед окрывающей и после закрывающей - есть пробел, после открывающей и перед закрывающей - нет. Примерно (вот так) или "так".
- Поскольку форум не различает длинное и короткое тире, то в нашем случае тире это знак "минус", который выделен пробелами с двух сторон, а "дефис" - он же но без пробелов по бокам.
- Не надо после каждого (второго) предложения ставить "восклицательный знак"!
Список конечно неполный, но покрывает большую часть потребностей.
Форматирование.
Если орфография проверена и знаки препинания расставлены, то можно перейти к украшательствам. Не стесняйтесь работать с форматированием. На форуме разрешены BB-коды, их список доступен здесь, используя BB-коды вы сможете существенно повысить привлекательность и читабельность текста, сфокусировать внимание читателей на важных моментах.
Заголовки частей и глав стоит выделять размером (команда [size=+1/2/3]текст[/size]), также можно использовать разное начертания - [b]полужирный[/b] или [i]курсив[/i], либо выделить цветом. Также, полужирный текст используйте чтобы выделить отдельную мысль (или привлечь внимание к чему-то), курсив для второстепенных частей или подписей к рисункам. Аналогично, вы можете использовать разный шрифт для выделения второстепенных (например подписей к рисункам) или важных частей. Не стоит использовать более 2-3 разных шрифтов, также желательно чтобы не менее 90% текста было написано одним шрифтом, желательно прямым.
Как мне напомнили, [u]подчеркнутый[/u] текст ассоциируется гиперссылками, поэтому настоятельно не рекомендуется к использованию для выделения текста.
Спасибо Maskerader-у, я совсем про это забыл. Еще есть зачеркнутый текст, но форум его по-моему не поддерживает. Упс. Поддерживает.
Если вы решили что-то выделить цветом (команда [color=DarkOrange]оранжевый текст[/color]):- Обратите внимание на читабельность текста на цветовом фоне форума. Например, синий текст плохо читается на коричневом фоне форума. Если вам все-таки нужно использовать синий цвет, то сделайте его полужирным.
- Не злоупотребляйте большим количеством слишком ярких цветов, например ярко желтым.
- Не стоит писать все буквы в слове, или все слова в предложении разным цветом без особой нужды.
- Имейте ввиду, что среди людей есть те, кто с трудом различает некоторые цвета, например красный и зеленый, или желтый и синий. По возможности не используйте эти цвета рядом.
Некоторые люди любят играть с выравниванием текста. Я лично предпочитаю не усердствовать, и использую выравнивание по левому краю (это выравнивание по-умолчанию). Выравнивание по правому краю обычно используется для эпиграфов, подписей, иногда цитат. Я не люблю выравнивание "по центру": когда человек дочитывает строчку до конца и начинает читать следующую, он автоматически начинает искать начало новой строки под началом предыдущей. Если текст выровнять по-центру, то приходится тратить дополнительное усилие на поиск начала новой строки.
В случае необходимости перечислить что-либо, воспользуйтесь маркированным либо нумерованным "списком". Можно конечно в ручную расставить биллиты или нумерацию, но в случае списка вы:- Не собьетесь с нумерации.
- Вам не нужно будет ее менять после добавки нового пункта в середине.
- Список будет выделен отступом от края.
Неважную, второстепенную (или например раскрывающую ответ какой-то загадки) информацию стоит прятать под "спойлер", или использовать команду "оффтопик".
Попугаи сожрали весь корм, надо купить хотя бы мюсли!
Изображения.
Скриншоты, для визуализации нужных моментов старайтесь делать с максимальным качеством графическим настроек игрового клиента. Можете наделать их с запасом, и потом выбрать подходящий. Во многих случаях скриншоты являются частью той информации, которую вы накопали и на основе которой пишите свое руководство. Запас карман не тянет, лишнее всегда успеете удалить. Зачастую нет нужды размещать полноразмерную картинку на форуме, воспользуйтесь графическим редактором (Gimp, Photoshop, MS Paint) для того чтобы вырезать нужный вам кусочек, что-то выделить или подчеркнуть. Подготовьте всю нужную графику, и сложите ее одном месте.
В этом руководстве я не буду фокусироваться на том, как кормить форум картинками. Об этом есть соответствующее руководство "Скармливаем форуму картинки. От плевков до моментальной победы!" Настоятельно рекомендую для ознакомления. После прочтения у вас не возникнет вопросов типа "почему половина картинки куда-то пропала?"
Если вы используете изображения в тексте, то старайтесь не разрывать абзац вставкой картинки в его середину. Разместите ее выше или ниже.
Улыбочку!
Мимо темы смайликов тоже пройти невозможно :). Полный список поддерживаемой форумом графики для отображения эмоций вы можете найти :2: "здесь". При использовании постарайтесь не злоупотреблять ими, т.е. не заканчивать каждое второй предложение смайликом и не ставить их кучками по несколько штук. Кроме маленьких, обычных смайлов большинство из которых имеет размер 15х15 пикселов и умещается в пределах высоты строки, форум поддерживает также большие и красочные Brand smiles размером 60х60 пикселов. 60-ти пиксельные смайлы визуально рвут текст, так что я бы не злоупотреблял :bs_smart:.
Итак наш бриллиант готов.
Осталось представить его на суд общественности.
Размещение руководства на форуме.
Раз ваше руководство подготовлено, проверено и вычитано, то самое время разместить его на форуме. Ваш путь лежит в раздел "Каталог руководств", где вам предстоит найти кнопку "Новая тема".
https://allods.mail.ru/forums/attach...hmentid=154197
Если у вас не получается создать новую тему, то для начала прочитайте вот тут: Как получить возможность создавать темы на форуме? Если права получены и тема успешно создается, то копируете написанный текст и загружайте картинки. Теперь нажмите кнопочку "Предварительный просмотр", и полюбуйтесь как будет выглядеть результат. Если результат предварительного просмотра вас устраивает, то нажатием кнопочки "Создать новую тему" вы разместите его на форуме.
https://allods.mail.ru/forums/attach...hmentid=154200
В тех случаях, когда ваше руководство получается очень большим (характерный пример - подробные классовые руководства), разбейте его на несколько частей. Первую часть разместите в самом первом сообщении темы, после чего добавьте остальные части в виде отдельных (почти пустых) сообщений той же самой темы. Если вы планируете размещать руководство по частям (и не сразу), то сразу после первоначального размещения, тоже создайте нужное количество ответов минимальной длины. Это будет ваш резерв на будущее, вы сможете отредактировать эти сообщения вписав в них последующие части. Этот же резерв можно использовать в дальнейшем для обновлений. Я поступил так с "Руководством для портных", в котором вторая часть была добавлена спустя полтора месяца после первой.
После того как руководство размещено, вам остается совершить еще несколько телодвижений:- В теме "► Каталог руководств (гайдов) ►" добавить сообщение о создании нового руководства, и попросить чтобы его внесли в общий каталог.
- Если вы считаете что ваше руководство качественное, то вы можете отправить его форумному Голему R2. Как это правильно сделать написано в теме "Премия за лучшие руководства".
- Если у вас осталось желание и время, то сделайте офф-лайн версию, например в виду pdf-документа.
- Запаситесь валерьянкой, и приготовьтесь ловить критику :).
Форумный голем модели R2, он же просто GolemR2 занимается рассмотрением руководств. Если он сочтет, что ваше руководство выполнено на надлежащем уровне, то в ответном сообщении вы узнаете свою премию. Кроме того, он может высказать соображения о том, что стоит изменить или дополнить.
Еще одной способностью R2 является выдача форумных медалей (бронзовой, серебряной и золотой) и присвоения знания "Знатока". Всего есть 3 категории:- https://allods.mail.ru/images/catalog/book1.png - бронзовая медаль, и звание "Знаток III".
- https://allods.mail.ru/images/catalog/book2.png - серебряная медаль, и звание "Знаток II".
- https://allods.mail.ru/images/catalog/book3.png - золотая медаль, и звание "Знаток I".
Пока что звания присваивались только один раз, а золотую медаль Знатока I класса не получил еще никто! Так что если вы постараетесь, то можете быть первым :).
Ааааа, я больше не могу редактировать свой гайд! Помогите!
Упс, прошло немного времени и вы не можете редактировать свой выстраданный гайд. А хочется внести правки, исправить не замеченные ранее ошибки, или отреагировать на критику. Что же делать? Вам придется попросить соответствующие права у администрации форума. И поможет вам снова GolemR2. Для этого нужно отправить личное сообщение Голему R2, и попросить нужные вам права. Только не забудьте мотивировать зачем вам это :).
Вот и все. Спасибо за внимание. Комментарии и пожелания приветствуются.
