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

01.11.2013

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

2. Живой документ

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

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

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

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

Никакой редакторский штат не может быть дополнен или улучшен доскональностью тысяч умных глаз читателей.

Но вот что должно быть понятно лучше всего: поисковые системы и Интернет обычно берут статью и ХРАНЯТ ЕЁ ВЕЧНО.

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

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

Обратная связь от читателей – это великолепно, но ещё лучше, когда с помощью неё делаются АПДЕЙТЫ и документ становится живым. Качественные технические документы – это всегда живые документы.

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

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

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