Инструкции пользователя и руководства

на русском и английском языке

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

Кому доверить написание справки?

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

Документацию должен писать специалист.

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

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

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


Узнать больше

Все виды документации

Я помогу вам создать справку к продукту, ЧаВо (FAQ) или пошаговые инструкции, описывающие те или иные действия. Результат предоставлю в нужном формате, включая DOC, HTML, CHM или PDF.


Особенности создания документации

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

Соответствие стандартам

В зависимости от потребностей заказчика, документация может быть разработана в соответствии с Microsoft guidelines, ЕСПД, ГОСТ Р ИСО или IEEE. Но можно и вольным стилем, если специфика проекта это допускает.

Иллюстрации и снимки экрана (screenshots)

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

Грамотное структурирование документации

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

Согласование терминологии

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

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


Узнать больше


Обо мне

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

Принимая решение, учтите плюсы и минусы:

Плюсы

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

Минусы

  • У меня нет лингвистического или журналистского образования. Возможно, для вас это значит больше, чем опыт.
  • Бываю занят заказами и клиентам приходится ждать своей очереди. Уточняйте сроки при заказе.
  • Работаю сам, заказы не делегирую, а следовательно, могу невольно допустить срыв сроков — заболеть, умереть и т.д.
  • Услуг SEO-копирайтинга я не оказываю. Лично я считаю, что это плюс, но у вас может быть другое мнение.
ПРОДАВАЙТЕР.РФ — © Пивоваров Дмитрий Владимирович