БЛОГ
Редактирование собственного документа
04.10.2013
Данная заметка посвящена тому, каким образом можно редактировать документы, которые вы сами и писали.
Технические писатели подчас заблуждаются в том, что пользователь глуп. Я часто слышу, как технические писатели говорят нечто вроде «ну, если пользователь этого не может понять, то, возможно, он не на той работе!»
Моё же мнение заключается в том, что пользователи не должны ничего понимать. Они читают нашу документацию не для развлечения, и не для того, чтобы расширить собственное сознание, или улучшить свою способность мыслить. На самом деле пользователи вообще бы не читали нашу документацию. Техническая документация – это обычно не более, чем необходимое зло, что-то, что требуется пользователю, чтобы справиться с задачей так быстро и безболезненно, насколько это возможно. Наша работа – создать документацию простой и безболезненной для чтения. Она никогда не должна вызывать моменты замешательства, стресса, беспокойства или раздражения. Пользователь не должен никогда говорить «чего?»
Основная причина непонимания пользователя – небрежное писательство. Вы можете подумать, что это очевидно, но на самом деле я периодически вижу руководства пользователей, в которых есть орфографические, грамматические и пунктуационные ошибки, пробелы в логике, двусмысленности, пропущенные слова, неправильные термины, а также необычное форматирование, которые затрудняет навигацию. Даже лучшие писатели допускают временами такие ошибки.
Эксперты без купюр
02.10.2013
Представляем статью американского эксперта по документированию, посвящённую его личному опыту общения с экспертами, с которыми приходится работать каждому профессиональному техническому писателю.
Допускаю, что я не всё знаю о специалистах-экспертах, или SME. Но я точно знаю, что есть некоторые вещи, которые вы должны избегать спрашивать у экспертов, особенно «Пользователь это уже знает?» и «Должен ли я объяснить это пользователю?»
Проблема с этими вопросами заключается в том, что т.к. эксперты склонны верить, что все знают столько же о технологиях, сколько они, то они обычно отвечают «Да!» на первый вопрос и «Нет!» на второй, а на самом деле всё должно быть наоборот. Метод технического писательства: Нет, пользователь ещё этого не знает и да, вы должны объяснить это пользователю.
Простой анализ аудитории
30.09.2013
Анализ аудитории – это чаще всего процесс предположения, а не тщательного исследования мышления и деятельности пользователя. На самом деле, анализировать вашу аудиторию без проведения каких-либо исследований очень легко.
По существу, есть всего две вещи, о которых технические писатели должны спросить себя на стадии анализа аудитории:
1. Что пользователь знает о том, что я пишу?
2. Что пользователь хочет знать о том, что я пишу?
Что знает пользователь
Я думаю, что даже если бы вы проанализировали свою аудиторию на следующие двадцать пять лет, то не смогли бы безошибочно понять, что аудитория уже знает.
Карьера технического писателя – Чего ожидать? (часть 3)
27.09.2013
Завершаем публикацию статьи об особенностях работы технического писателя. В заключительной части статьи речь идёт о работе в качестве сотрудника, а также даются советы для руководителей.
Работа в качестве сотрудника
Если вы работаете как сотрудник, то правила практически такие же, как и для всех других сотрудников. Ваши налоги вычитаются из вашей зарплаты и вы получаете бонусы для сотрудников. Предполагается, что вы будете работать определённое число часов в неделю и будете участвовать в общественных мероприятиях, проводимых компанией.
Вы отчитываетесь перед боссом, который говорит вам, что делать. Босс оценивает вашу производительность как сотрудника. Возможно, вам необходимо будет писать еженедельный отчёт. Отправляйте его себе в электронный ящик, так как при этом сохранится штамп времени.
Компании «ПроТекст» исполнилось 2 года!
26.09.2013
Дорогие друзья!
Сегодня компании «ПроТекст» исполнилось 2 года.
За этот небольшой срок у нас появилось множество постоянных клиентов, которые на своём опыте узнали преимущества разработки документации по модели аутсорсинга. Мы обучили и сертифицировали десятки технических писателей, открыв им дополнительные возможности для карьерного роста.
Наша компания не стоит на месте, и уже в следующем году планируется открытие филиала в Минске.
Мы благодарим всех своих партнёров, клиентов, слушателей, участников наших сообществ в социальных сетях за общение, обмен опытом и пожелания по совершенствованию нашей деятельности.
История продолжается! 🙂
Карьера технического писателя – Чего ожидать? (часть 2)
25.09.2013
Во второй части статьи продолжается обсуждение особенностей работы технических писателей по модели фриланса. Раскрывается специфика налоговых режимов полноценного сотрудника и фрилансера в США и Канаде, а также наиболее выгодные методы оформления отношений между фрилансером и работодателем.
…Даже если вам платят больше, чем техническому писателю, работающему на полный день, компания, на которую вы работаете, экономит деньги, потому что вы не сотрудник. Компаниям не нужно платить налоги за работу фрилансеров в таком же размере, как за работу сотрудников. Так как правительства получают больше денег с компаний, которые нанимают сотрудников, чем с компаний, которые нанимают фрилансеров, они склонны относиться подозрительно к компаниям, которые нанимают большое количество фрилансеров. К тому же, так как в качестве консультанта вы можете получить гораздо больше налоговых льгот, чем сотрудник, правительства могут отнестись подозрительно и к вам тоже, если только у вас нет собственных сотрудников. Если правительство, по крайней мере, в США или Канаде, поверит в то, что по всем внешним признакам вы сотрудник, а не фрилансер, они могут отменить все заявления на получение налоговых вычетов, а также могут заставить вашего клиента заплатить налоги, как если бы вы были сотрудником.
Карьера технического писателя – Чего ожидать? (часть 1)
23.09.2013
Что вы можете ожидать от карьеры технического писателя? Ответ зависит от нескольких факторов. В особенности от того:
- Будете ли вы самостоятельным техническим писателем или частью команды технических писателей?
- Будете ли вы техническим писателем-фрилансером или сотрудником?
Работа в качестве самостоятельного технического писателя.
В этой ситуации вы будете отвечать за весь проект документирования, от стадии планирования до сдачи. Вы должны уметь оценить продукт и проанализировать требования клиента, чтобы определить информацию, которая необходима конечному пользователю. Вы должны будете разработать шаблоны документов в комплекте документации и убедиться, что документы протестированы перед сдачей. Вы напишете все документы из комплекта, то есть вы будете писать как инструкции по установке, так и описания API и онлайн-справку. Вы также будете консультировать команду разрабочиков по удобству использования продукта или приложения.
Интервью с Крис Питер. Получите совет от экспертов в области технического писательства!
20.09.2013
Крис Питер (Chris Peter) работала техническим писателем в Reebok Corporation (корпорации «Рибок»), компании, которая производит обувь и спортивную одежду. Она также вела курсы для писателей в Дартмутском филиале Массачусетского Университета.
Какие навыки у вас были, когда вы начинали работать в сфере технического писательства?
Когда я окончила Профессиональную программу для писателей в Дартмутском филиале Массачусетского Университета, у меня были солидные навыки по документированию. Я прошла множество полезных курсов, включая техническое писательство, исследовательскую журналистику, а также разметку и дизайн. У меня было множество писательских навыков, а также опыт работы в условиях жёстких дедлайнов. Я чувствовала недостаток только в одной области – серьёзном совместном писательстве. Работая техническим писателем, вы работаете в команде с инженерами, дизайнерами, людьми, обеспечивающими качество… Чтобы быть успешной, вам нужны общие человеческие навыки и навык интервьюирования.
Вы решили, что хотите стать техническим писателем, в магистратуре?
Я наслаждалась своей карьерой технического писателя, но знала, что не остановлюсь на этом. Я хотела обучать, быть вовлечённой в педагогическую часть.
Как работать техническим писателем, даже если у вас нет опыта (часть 3)
18.09.2013
Завершаем публикацию статьи о том, каким образом начинающие технические писатели могут улучшить свои навыки и увеличить шансы найти работу. В заключительной части речь пойдёт о прохождении тестирования и собеседования, а также важности прохождения стажировки.
Станьте асом в тесте на редактирование
На некоторых собеседованиях вам нужно будет пройти тест, длина и сложность которого зависит от работодателя. Если вам дадут тест на редактирование всего лишь небольшого абзаца, спросите, написал ли его человек, который вас собеседует.
Если параграф написан плохо, не говорите об этом. Откорректируйте его настолько хорошо, насколько можете, и приготовьтесь ответить, почему вы сделали эти изменения. В этой ситуации вам поможет знание правил грамматики, потому что вы можете использовать их для минимизации негатива от ваших правок. Так что вместо того, чтобы сказать «Это написано не очень хорошо», вы можете сказать нечто вроде этого: «Это предложение содержит уточнение, стоящее не на своём месте. Я исправил это перестановкой частей предложения». Если, однако, абзац написан хорошо, скажите об этом, но укажите, почему вы думаете, что он написан хорошо. Вы можете сказать примерно так: «В этом типе предложения я часто встречаю такую-то ошибку. Автор явно позаботился о том, чтобы её избежать, сделав “x” вместо “y”».
Как работать техническим писателем, даже если у вас нет опыта (часть 2)
16.09.2013
Продолжаем публикацию статьи о том, каким образом начинающие технические писатели могут улучшить свои навыки и увеличить шансы найти работу. В этой части речь пойдёт об использовании программного обеспечения, писательском опыте и создании демонстрационного документа
Знайте своё программное обеспечение
Так же как и небольшой писательский опыт важна способность использовать программное обеспечение. Вы должны знать, как использовать Microsoft Word. Если компания требует знания FrameMaker, например, а вы знаете только Word, не позволяйте этому помешать себе написать заявление на эту работу. Если вы хорошо знаете, как использовать Word – и я имею в виду, по-настоящему хорошо – вы сможете применить это знание к другому инструменту.
Что я имею в виду под «по-настоящему хорошо»? Ну, вы должны знать, как делать следующее:
Читать дальше…