Writing Guides-ru

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

Что надо для этого делать? ¶ 

Создавайте! ¶ 

Любое руководство в тысячу раз лучше, чем его отсутствие. То, что написано ниже не является правилами, но рекомендуемо к исполнению. Даже мы иногда забываем следовать этим рекомендациям. Ведь мы все люди и делаем ошибки. Даже это руководство будет улучшаться со временем, так что не думайте, что всё должно быть сделано идеально с первого раза. Будьте новатором!

Делайте потрясающие фотографии ¶ 

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

Дополняйте фотографии текстом ¶ 

Фотографии и текст должны дополнять друг друга. Дополнительные изображения могут использоваться для дополнения текстового объяснения.

Будьте наглядными ¶ 

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

Ориентация на показ ¶ 

Постарайтесь (насколько это возможно) держать ориентацию устройства одинаковой на протяжении всего руководства. Ведь читатель должен легко определить положение устройства. И если вы изменяете положение, то дайте читателю знать об этом, например, «Поверните устройство» или «поверните устройство на 90 градусов», так вы очень поможете читателю.

Минимизируйте второстепенную информацию ¶ 

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

Внутренние ссылки — мощный инструмент ¶ 

Внутренние ссылки — это ваши друзья. Ссылайтесь всегда и везде (если необходимо) в другие места сайта.

Пишите только по теме ¶ 

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

Будьте информированными в теме ¶ 

Если вы добавите уместную информацию по теме, то это добавит вашему руководству авторитетность.

Будьте проще ¶ 

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

Используйте только подходящие маркеры списков ¶ 

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

Добавляйте заметки по сборке устройства ¶ 

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

Включайте в руководство схемы ¶ 

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

Что НЕ надо делать ¶ 

Не увлекайтесь отметками на фото ¶ 

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

Не злоупотребляйте названиями шагов ¶ 

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

Не используйте первое лицо ¶ 

В команде, как и здесь, нет место для "Я". Поэтому не используйте "Я сделал" в своих руководствах и тогда вы будете выглядеть более авторитетно.

Здесь не место для высказывания своего мнения ¶ 

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

Не используйте пассивный залог ¶ 

Будьте прямы в своих инструкциях пользователям. Не попадитесь в ловушку "Вот это", и вместо этого используйте глаголы для высказывания своей мысли.

Не используйте чужой контент ¶ 

Загружайте только то, что вы сами написали или сфотографировали, или то, на что вы имеете права.

0 Comments

Add Comment

View Statistics:

Past 24 Hours: 0

Past 7 Days: 0

Past 30 Days: 0

All Time: 103