Всё для технического документирования
+7 (495) 001-00-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Новости о техническом писательстве

Программы-антиплагиаторы: развенчиваем 5 заблуждений

24.12.2015

01Мы начинаем серию статей, посвящённую программам-антиплагиаторам и соответствующим веб-сервисам. Часто возникают вопросы в связи с использованием этих автоматизированных средств. Авторы указывают на то, что антиплагиаторы не всегда точны, и это правда. Заказчики контента желают получить 100%-но уникальные тексты, и это желание понятно, но не при всех начальных условиях этот результат достижим и объективно необходим. Попробуем разобраться в границах применимости автоматических антиплагиаторов и методах правильной интерпретации их результатов.


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

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



Практические советы Стивена Кинга для технических писателей

31.10.2015

01Представляем вашему вниманию статью Рикки Эндсли (Rikki Endsley), менеджера по сообществу Opensource.com, ранее работавщую над продвижением идей свободного ПО в Red Hat. Статья посвящена основным принципам технического документирования для широкой аудитории.


Даже если вам не нравится писать, и вы не собираетесь становиться профессиональным техническим писателем, есть вероятность, что в некоторые периоды вашей карьеры вам придётся писать проекты докладов, материалы для почтовой рассылки или технические статьи. И, вооружившись несколькими практическими советами, которыми с высоты своего опыта поделился Стивен Кинг, вы сможете развить свои способности ещё до того, как начнёте писать. И, при правильном планировании, вы сможете легко модифицировать свои материалы для различных категорий пользователей. Читать дальше…



21 совет по веб-дизайну для начинающих

28.07.2015

01Мы продолжаем мини-серию статей, посвящённую дизайну, темой веб-дизайна. Здесь речь идёт не только о внешнем виде сайта, но и о текстах, удобстве и авторских правах. Кто знает, чем придётся заниматься вам, как техническому писателю, завтра? А может быть, следить за веб-сайтом компании уже входит в ваши обязанности или у вас есть свой сайт, как у небезызвестного Тома Джонсона? Тогда сегодняшний материал – для вас.

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

 

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

Что они делают для того, чтобы стать успешными?

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



Как написать техническую базу знаний для вашего сайта

08.07.2015

00Размышляете о создании базы знаний для вашего бизнеса? Эта статья рассказывает об основах того, как обеспечить хороший уровень технического документирования вашего сайта.


 

Что такое техническая база знаний и зачем она вам нужна?

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



Что такое структурированное писательство?

18.06.2015

Статья входит в цикл «Понимание и применение структурированного писательства».

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


Я не любитель широких определений больших терминов. Определения должны прояснять значение, но попытки определить такие термины как «контент» и «контент-стратегия» лишь вызывают споры. Предлагаемые определения часто рассчитаны не столько на то, чтобы прояснить значение, как на то, чтобы застолбить некоторую область. Так же и сочетанию «структурированное писательство», по сути, требуется что-то вроде определения, не потому что его значения размыты, а потому что они сильно разнятся. Это результат разнородности интересов, а не отсутствия определения. Моё определение — это декларация моих интересов, не более.

Давайте начнём с как можно более общего определения типа «обхвати-руками-всё-сразу»:

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

Читать дальше…



9 факторов, влияющих на качество контента

10.06.2015

00Понятие качества – вещь сложная, а когда дело касается контента, то, как и при оценке любого неосязаемого явления, вообще затруднительно найти подход. Что оценивать? Стиль? Так это необъективное понятие. Подачу материала? Встаёт вопрос: а как? Какой контент имеет больший вес – инструкция к продукту или маркетинговые материалы? А надо ли вообще об этом задумываться? Много вопросов, и непонятно, с какой стороны подойти. Джилл Парман, владелец компании ForWord Consulting, утверждает, что создание и поддержка качественного контента – это вызов, и она знает, как его принять. Давайте вместе с ней разберёмся, какие критерии являются решающими при оценке качества и что с ними делать, чтобы добиться результата.


Встаньте на путь к хорошему контенту, оценив качество по показателям

Посмотрите в нескольких словарях определение слова «качество» и вы обнаружите много вариантов. Поговорите с людьми, которые управляют организациями, руководят командами по обеспечению качества или ведут блог о моде или еде, и у вас появится ещё больше определений. Одно из базовых определений описывает качество так: «в какой степени что-то хорошо или плохо». Другое продвигается на шаг вперёд и предполагает, что именно указывает на качество: «высокий уровень полезности и мастерства» (оба взяты отсюда: http://www.merriam-webster.com/dictionary/quality). Значит, определить, что представляет собой качественная документация, учебные материалы или вебсайты, раз уж вы взаимодействуете с этими материалами – легко, верно? Ну, да вы уже знаете ответ на этот вопрос. Читать дальше…



Словесные премудрости: параллелизм заставит выравнивать по левому краю (часть 2)

15.10.2014

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


А так как этот воображаемый список висит на воображаемой дверце моего холодильника, он выровнен по левому краю.

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

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

Как обновить комплект

Загружаем прошивку

Устанавливаем операционную систему

Подключение к облаку

Аналитика Читать дальше…



Словесные премудрости: Параллелизм заставит выравнивать по левому краю (часть 1)

13.10.2014

13.10.14Представляем вашему вниманию очередную статью Марсии Рифер Джонссон, которая не устаёт делиться с нами маленькими секретами красивого языка и грамотного повествования.


 

Параллелизм. Это слово само по себе – пара рельсов, идеально выравнивающих образы вещей. Ряды кукурузы. Линии напольной плитки. Кольца географической широты. Когда вы говорите или пишете, вы выравниваете слова. Это происходит естественным образом. Вы забегаете в магазин и говорите: «Мне, пожалуйста, фисташки, тунец и шампанское». Вы не думаете «Мне надо выровнять ряд существительных». Существительные сами выравниваются. Слова ищут себе подобных, как сказал Шеридан Бейкер: «…существительное к существительному, прилагательное к прилагательному, инфинитив к инфинитиву» (The Practical Stylist, 1998). Читать дальше…



Пишем контент. Простота имеет значение для Google

22.09.2014

22.09.14Представляем вашему вниманию очередную статью Джулианы Вайсс. Сегодня она поделится с нами мыслями о том, как поднять свой сайт в поисковом рейтинге, всего лишь немного изменив терминологию в блоге.


Может ли техническая сложность веб-контента улучшить или ухудшить позицию вашего сайта в рейтинге поиска?

Другими словами, будет лучше, если на сайте содержится почти экспертная терминология, либо блоггеры и другие производители контента должны стремиться к более доступному контенту?

Недавно Мэтт Каттс из Webspam Team компании Google осветил эту тему в видео на YouTube, и его ответ оказался намного проще, чем вы могли ожидать. Читать дальше…



Словесные премудрости: Слова-связки

22.08.2014

22.08.14Мы часто публикуем советы по каким-то техническим трудностям профессии технического писателя. Но не стоит забывать о том, что технический писатель – он всё-таки не только технарь, но и писатель. То есть о писательских навыках, грамматике и стилистике тоже нужно помнить. Сегодня Марсия Рифер Джонссон поделится с нами размышлениями о важности плавного повествования.

Хотите начать лучше разбираться в стилистике технических текстов, изучить множество других вопросов по теории разработки технических текстов и приобрести практические навыки? Всё это Вы получите, освоив курс «Разработка технических текстов и документации».

Что не так с этим отрывком?

Связки делают поток слов плавным. Связки — это слова или фразы, иногда целые абзацы, которые присоединяют одну идею к другой. Обычно (!) связки ставятся в начале предложения или абзаца. Они могут ставиться в середине или в конце. Они направляют своего читателя, раскрывая логику развития мысли. Чрезмерное использование связок может запутать или отвлечь читателей. Избегайте использования связок в каждом предложении. Абзацы – другое дело. Если вы не пишете прямое повествование – это произошло, то случилось – в большинстве абзацев должны быть связки. Думайте о предложениях и абзацах, как частях тела. Они и есть части тела. Телу нужны суставы. Читать дальше…