Шесть Причин Вы не Нуждаетесь в Техническом Авторе (и Почему Они Мертвы Неправильно!)

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

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

  • проектирует удобный в работе и документы, "легкие найти".
  • пишет ясные и понятные инструкции.
  • демонстрирует широкий диапазон технического знания, которое позволяет ему или ей приобрести новое техническое знание быстро. Большинство технических авторов процветает при изучении неясных технических фактов столько же, сколько они любят обсуждать достоинства точки с запятой. Лучшие технические авторы - удивительно быстрые исследования.
  • создает шаблоны документа с чистым, профессиональным появлением, которое может снова использовать Ваша компания.
  • задает интеллектуальные вопросы Вашего SMEs (эксперты по предмету), что Вы не могли бы думать, чтобы спросить, гарантируя полный охват особенностей продукта.
2. Программисты или инженеры могут написать документацию. О, действительно? Они уже не достаточно заняты? Большинство программистов и инженеров, с которыми я работал, ненавидят письмо. Позвольте им делать то, что они прилагают все усилия и позволяют автору делать то, что она прилагает все усилия.

Хорошие технические авторы - пользователи власти большинства программ обработки текста, ШЛЯПЫ (помощь создающие инструменты), и посвящены в последние методы документации, которые увеличат профессиональную репутацию Вашей компании. Хороший технический автор - здравый смысл о тенденциях проекта и лучших методах. Вы можете сказать это для своих инженеров и программистов?

3. Вы нуждаетесь в авторе об участке. , Почему? Это - 2005. У большинства внештатных технических авторов есть быстродействующие интернет-связи, машины факса, и сотовые телефоны. Я работал с клиентами, которых я даже не встретил или кого я встретил только пару раз для встреч обзора документации. Это хорошо для автора, и это хорошо для Вас, когда у Вас нет дополнительного тела, занимающего Ваше ценное место. Я развил некоторые из своих лучших профессиональных отношений в киберпространстве.

4. Только Вы понимаете потребности своих пользователей лучше всего. Да, Вы делаете. Вы знаете то, что они хотят и в чем они нуждаются; именно поэтому Ваш бизнес настолько успешен. Рассмотрите следующие вопросы:

  • Ваша документация должен быть приспособлен пользователю новичка или опытному техно-выродку?
  • Вы знаете, как проанализировать Вашу аудиторию и написать той аудитории?
  • Вы понимаете основной стиль изучения своей аудитории?
  • графика будет работать лучше чем слова, чтобы передать Ваше сообщение?
  • Будет компакт-диск или ОСНОВАННАЯ НА HTML работа помощи онлайн лучше чем документация печати?
  • , Как Вы поставите и распределите заключительный продукт документации?
Хороший технический автор выполнит пользовательский анализ потребности и обеспечит план документации, который ведет Ваш информационный проект архитектуры. Она создаст план документации, который разовьется в течение проекта и позволит документации расти как Ваши изменения продукта. С большим фондом Вы не должны будете повторно изобрести колесо с каждым новым повторением Вашего продукта.

5. Вы уже знаете, как использовать MS Word. Это велико, и это важно.

  • Вы мечтаете в макроопределении?
  • Вы знакомы с Плотником (очень нелегкий в использовании, но сильный любимый инструмент технических авторов, который обращается с большими, сложными документами, которые делают дрожь MS Word и крушение)?
  • Вы когда-либо проектировали помощь онлайн, используя RoboHelp?
  • , Как Ваш Фотомагазин, Иллюстратор, Про Магазин Краски, Кварк, Visio, InDesign, и основной HTML, кодирующий навыки?
  • Вы знаете о последних тенденциях в письменной форме и стиле грамматики так сообщение Вашей компании, будет последователен и грамматически исправит?
Хорошие технические авторы приносят обширное практическое знание множества обработки текста и графических программ так же как стандартных методов письма бизнеса.

6. Вы можете не отставать от обновлений документа.

  • , Каков Ваш план относительно контроля за версией документации?
  • , Кто напишет обновления?
  • <у лития>, Как Вы гарантируете Вашим пользователям, есть последняя и самая большая версия?
Если у Вас нет версии и исходной системы управления в месте, многократные версии Вашего документа в нескольких папках создают организационный кошмар, когда пришло время пересматривать или обновлять.

Есть тенденция к единственной sourcing технической документации в эти дни. Проще говоря, это означает один источник для всех Ваших потребностей документации. Этот единственный источник может содержать материал для Ваших руководств печати, онлайн помочь, и учебные материалы все в одном месте. В единственном sourcing автор помечает определенный материал для определенного использования. Когда Вы поставляете документацию, Вы просто определяете тип документации, которую Вы хотите (e. г., печать, онлайн помогите, руководство пользователя, учебная материальная, техническая информация ссылки), чтобы создать, и программное обеспечение делает остальных. Пункт, все находится в одном месте, делая версию и исходный простой контроль. Настраивание единственной sourcing системы теперь спасет Вас время и будущие головные боли позже. Хороший технический автор знаком с тенденциями промышленности для единственного sourcing и может быть в состоянии помочь Вам настроить единственную sourced систему в пределах Вашей организации.

Если Вы сомневаетесь в найме технического автора, рассматриваете это. Хорошие письменные навыки коммуникации будут всегда пользоваться спросом в деловом мире. Однако, в сегодняшнем сложном деловом мире, только будучи хорошим автором не достаточно. Хороший технический автор нуждается в техническом здравом смысле, звуковом знании множества программ, и безупречном исследовании и письме навыков.

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

Copyright 2005 Ann Zuccardy. Все права защищены.




  • Меню