Техническое писательство в эпоху свободного программного обеспечения (часть 1)

30.10.2013

В настоящей статье главный редактор портала ReallyLinux.com размышляет о том, как наличие открытого программного обеспечения влияет на процесс технического писательства

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

1. Система обратной связи с пользователем

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

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

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

Например, одна из наших статей получила 2 327 комментариев за 30 часов:

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

Немногие вещи могут научить технического писателя так, как получение тысяч комментариев к статье. Даже комментарии, не соответствующие её тематике, проливают свет на то, о чём думают читатели, что им требуется, какие у них проблемы.

Контент – не король, он подчиняется потребителям контента. В нашем случае это читатель. И вместе с бесчисленными веб-сайтами и блогами, скомбинированными с мощными поисковыми машинами, исследование обратной связи никогда не было таким лёгким и быстрым.

Одно из моих требований для писателей – они следят за жизнью статьи, исследуя все повторные публикации и сайты и читают столько отзывов читателей, сколько возможно. Каждый человек, оставляющий отзыв на статью, даёт информацию о каком-либо аспекте статьи.

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

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

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

Самое прекрасное в наш технический век то, что статью можно улучшать во время получения отзывов читателей.

(продолжение следует)

Источник: Tech Writing in the Age of Open Source

Тэги: анализ, веб-контент, опыт, советы

< Вернуться к списку публикаций

Техническое писательство в эпоху свободного программного обеспечения (часть 1)

Облако тегов