Как создать отличное руководство

Любое руководство в тысячу раз лучше, чем его полное отсутствие. Приведенные ниже пункты — это не правила, а рекомендации. Даже мы иногда забываем следовать им всем или возвращаемся, чтобы что-то отредактировать при необходимости. Мы знаем, что все мы люди и совершаем ошибки. Эти руководства со временем станут лучше, поэтому не думайте, что всё должно быть сделано идеально с первого раза. Будьте первопроходцем!

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

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

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

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

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

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

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

Добавление большего количества уместной информации придает вашему руководству по ремонту авторитетности.

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

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

Если устройство достаточно простое, примечания по сборке могут не потребоваться. Но процесс сборки также может требовать особых инструкций. Например, разборка ЖК-экрана MacBook довольно проста. Однако если при сборке не проложить провода правильно, они не дотянутся до разъемов на логической плате. Читатели будут вам очень благодарны, если вы добавите небольшие подсказки, которые помогут им собрать устройство после того, как оно будет разобрано на части.

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

Слишком большое количество разметки на фото сделает его пугающе непривлекательным для читателя. Добавляйте только то, что необходимо для идентификации объекта, если вы вообще считаете, что разметка нужна. Если вы добавляете более 4–5 элементов разметки, возможно, стоит разбить работу на несколько шагов. Если сомневаетесь — посмотрите на руководства iFixit!

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

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

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

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

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