Написание программного обеспечения Руководство пользователя в MS Word

Question

Я собираюсь написать руководство пользователя программного обеспечения (написано для Windows) для программного обеспечения, которое мы написали для нашего клиента. Руководство должно быть как можно более подробным. Я собираюсь использовать MS Word 2010, чтобы написать руководство.

Я планирую поставить много скриншотов различных окон программного обеспечения и аннотировать на скриншотах. Размер страницы должен быть А4, чтобы пользователи могли легко делать распечатки. Проблема заключается в том, что если я сделаю снимки экрана в полноэкранном режиме (программа занимает весь экран, кроме панели задач) и попытаюсь разместить их на бумаге формата A4, многие тексты на окнах, а также аннотации могут быть трудно читаемыми.

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

Проблема в том, что я не знаю, можно ли это сделать в Word. Является ли это возможным? Если нет, есть ли альтернатива / лучший подход?

Answer 1

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

• Им нужен полный скриншот или вы пытаетесь привлечь внимание к определенной детали?
  Если нет, возможно, вы можете немного обрезать изображение.

• Не могли бы вы уменьшить разрешение вашего компьютера, чтобы сделать снимок экрана с меньшим количеством потерянного пространства?
  Вместо того, чтобы снимать скриншот с разрешением 1920x1080, попробуйте сделать снимок с разрешением 1024x768 (или чуть более высоким / низким разрешением в зависимости от ваших предпочтений). Таким образом, вместо того, чтобы сильно уменьшать изображение, чтобы оно уместилось на странице, потребуется лишь небольшое уменьшение (или даже увеличение), чтобы сделать его более читабельным.

Answer 2

Я на самом деле написал много технической документации в Word. Это не тот инструмент, который я бы выбрал, если бы у меня был свободный выбор, но технические писатели часто этого не делают.

То, что вы говорите об этом, безусловно, выполнимо - но я могу только сказать, что когда я делаю некоторые предположения о том, как вы собираетесь доставлять руководство. Если вы планируете выпустить руководство в формате PDF и разместить эти внешние снимки экрана в Интернете, то да, это выполнимо. Word 2010 позволяет вставлять URL-ссылки в любое место документа. Эти ссылки сохраняются при сохранении файла в формате PDF.

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

Вы не спрашивали о программном обеспечении, но я все равно рекомендую. В Windows SnagIt - незаменимый инструмент для создания снимков экрана. Это всегда было хорошо, и с годами становилось только лучше. Механизм захвата становится все более и более мощным и простым в использовании, и теперь эта чертова штука поставляется с довольно хорошим графическим редактором, как раз для рисования этих выносок.