Написание технических текстов для напуганных
IntroductionSometimes это может быть за пределами компании или отдельные лица, бюджет, чтобы нанять профессионального писателя для удовлетворения их технической документации. Хотя в идеальном мире все техническая документация должна производиться По высококвалифицированного эксперта, к сожалению, мы живем не в идеальном. Таким же образом, что многие люди будут пытаться восстановить свою собственную бытовую технику, многие люди будут пытаться писать качеством технической документации. Подобно тому, как возиться с тостером может привести к поражению электрическим током, пытаясь писать технические документы с нуля, без предварительных консультаций, в конечном итоге приведет к неудаче. В качестве грубой правило вы должны всегда стремиться нанять специалиста, но если по каким-либо причинам вы не можете и вы несчастный, который был навязан обязанностей документация на них, не отчаивайтесь. В этом кратком руководстве излагаются некоторые основные навыки, вы будете Необходимо довести до вашего написания технических конвенций быть в курсе, программных пакетов, которые можно рассмотреть, и определенно чего следует избегать. Надеюсь, даже если вы никогда не писали приговор в своей жизни ни о чем смутно технического вы будете иметь, по крайней мере, более широкое представление о том, что технические entails.What письменной форме Технические писать? написание технических текстов Неудивительно достаточно, относится к письменной форме, что является техническим. Хотя Это может показаться ошибочным определению, это важно помнить одно. Слишком много технических авторы делают ошибку, создавая документацию, которая является либо слишком техническим, либо слишком "литературным". Хорошая техническая Автор должен иметь возможность регулировки баланса между этими двумя в соответствии с конечным потребителем документации. Написание технических текстов очень много, как свежий воздух, повсеместные и еще почти невидимым. В странных проводных Мир в котором мы находимся, написание технических текстов повсюду. Программное обеспечение пособий, руководств пользователя для бытовой техники, учебные брошюры, письма, письма, отчеты, доклады технические новости, статистика и биографии Телевидение показывает, спорт Все они являются примерами Технические статьи, в которой люди подвергаются на ежедневной основе. Если у вас когда-нибудь пытались программа настройки времени на видеомагнитофон домой и швырнул через руководства комната с отвращением, вы бросили кусок технического письменном виде (хотя, очевидно, не очень хорошая!). Слишком много раз техническая литература создается с писателями не достаточно большим пониманием технологии, или отличие от "плохих" писателей, которые обычно можно найти грабеж Sweet старушкам или что-то). Техническая документация, как правило, производится по двум различным группам пользователей, а именно: опытные пользователи уровне и наивных пользователей. Как технические одним автором вашей первой задачей является разобраться в какой аудитории вы пишете для, которые ловко подводит меня к: Знайте свои foeAs старой clichÃÆ'Ã,  © идет, каждого критика. Это особенно верно реакция наиболее здравомыслящие люди, когда сталкиваются с техническими письменной форме. Как было подчеркнуто на примере видеомагнитофон выше, написание технических текстов может быть непроницаемой для конечного пользователя. Если это так, то это потому, тот, кто пишет документацию, не беспокоить, чтобы определить свою аудиторию и писать на своем уровне. Кажется очевидным точку сделать, но тот, который часто упускается из виду, что пользователь ваши документы создают, в действительности может не быть экспертом. Очевидно, что если вы создаете документ по конкретному продукту специалиста по конкретной передовой группы пользователей (хороший пример может быть аудита программного обеспечения для компьютерной системы администраторов), то вам необходимо будет составить это совершенно иначе, чем если бы вы создаете, например, техническое руководство для массового компьютерного рынка программного обеспечения, направленные на неопытных пользователей домой. Один из первой задачи необходимо выполнить прежде, чем даже браться за перо, из пальцев на клавиатуре, это определить, кто из ваших пользователей документы будут построены и документов, направленных на этой конкретной целевой группы (ов). Если Вы получите этот этап правильно, он должен избегать ваши документы, которые бросили через номерах с досадой! Планирование perfectionOnce вы определите целевой рынок для документов, которые вы будете создавать, то вам нужно , чтобы начать планировать, как документы будут организованы. Этот процесс в значительной степени зависит от того, что документация производится, но Вы можете выполнить несколько грубой эвристики. Во-первых, если документы в поддержку Особенно подробную информацию о продукте (например, компьютерной программы) получить ваши грязные руки на нее так же быстро, как вы можете. Изучив продукт подробно вы можете составить план нападения и начать сочинять организационная структура. Хотя вы изучают продукт в деталях, принять обильное отмечает, как делают это в ходе первоначального разведочного этапа позволяет сэкономить время, которые могут быть абсолютно необходимо, если вы работаете срок. Даже на этапе планирования вы должны убедиться, существует последовательность в макете и организационная структура для документа. Выберите нумерации конвенций, стили абзацев, и генерировать идеи для грубой макет цели сейчас, и сохранить жизненно важные later.Let раз проект inBefore дайвинг головой в создание документации, проектов из каждого раздела первого. Это позволит на порядок, если документы создаются не имеют логическое "потока", не имея серьезного влияния на проект. Многие технические документы (особенно для более подробного товаров) состоят из многочисленных (и в некоторых случаях практически бесчисленное) итераций. Это потому что продукт сдвиги и изменения с течением времени, и одной из основных обязанностей технического автора в курсе этих изменений, и обеспечить, чтобы все они хорошо документированы. Хорошие технические авторы всегда отстаивать свои документы через столько проекты как по-человечески возможно, переработки по каждому проекту, пока они не достигнут такое положение, когда они (и их работодателя) удовлетворен тем, что документация является своевременной, точной и и части точности означает быть подробными, насколько это возможно для человека. Даже если документы, которые вы создаете предназначены для передовых и технологически сложные группы пользователей, документацию должны сосредоточить внимание на детали процесса, либо в использовании продукта. Это может быть трудный подвиг совершить, но если вы пишете на вашу аудиторию. Никогда не думайте, что читатель ничего не знает о рекламируемом продукте или процессе быть документально подтверждены, а в случае передовые / пользователей эксперт по крайней мере, здравого смысла, чтобы признать тот факт, что они, вероятно, не надо сообщать, как используется оборудование, они действуют на ежедневной основе. При описании, как выполнять конкретного вида деятельности или задачи, определить участие каждого этапа (число их, если это соответствует конвенциям от типа документа вы создаете) и для обеспечения точности, что у вас есть письменное тестирование самостоятельно, или даже лучше, веревка в добровольном той же квалификации, как в конце user.Choose правильный инструмент для jobAlthough можно создавать технические документы, используя пергамент и крови, то это не рекомендуется. Много специалистов программных приложений существуют, чтобы помочь вам создать мощную документацию, и часть ваших обязанностей в качестве технического автора, включать выборе правильного инструмента для работы. Во многом это зависит от характера документов производится, и характер их последующего распределения. Если документы могут быть доставлены с использованием Интернета, это, безусловно, проспект рассмотреть. С этой целью использовать пакеты, такие как Flash MX и Dreamweaver для достижения этой цели. Для комплексного справки, вы можете создать сырые документы HTML, или же выбрать специалиста пакет таких как RoboHelp или аналогичный. В случае печать основана документы, Вам будет необходимо выбрать пакет программного обеспечения достаточно мощным, чтобы ручка, что вы будете бросать в it.Many неопытные авторы технических моментально повернуть в сторону Microsoft Word (как это происходит повсеместно в коммерческих и мочь частные среды). Если ваша документация будет под 150 страниц, и вы знаете, как создавать шаблоны и сделать макросами, избежать MS Word. Как и любое техническое автор скажет, что это имеет неприятные привычки все это собственную, и часто может быть неустойчивым пакет для работы с. При создании графического тяжелой документация, вы, возможно, пожелает рассмотреть Quark Xpress, или выбрать потенциально отраслевым лидером в области, Adobe FrameMaker. Независимо выборе программного обеспечения, вы должны убедиться, вы стали невероятно Proficient с ним, либо за счет инвестиций в обучение, или, используя ее каждый день за днем! Общение - вот что вам платят делать! Многие люди скажет вам, что создание технической документации и утомительным повторением. Эти люди не правы, и, возможно, тоже идиоты. Хотя вы можете найти в процессе создания технической документации 'скучно' (если вы Вы находитесь в неправильной работе!) это не так. Создание качественного технического документа является важным этапом в позволяя людям адекватно и правильно использовать технологию. Хотя ни один пользователь будет приближаться к документации, вы создаете в так же, как они подходят к роману, можно в конечном счете, помочь им достичь того, чего они хотят добиться с использованием технологии. Независимо от того, как "скучный" процесс может показаться, что позволяет пользователям для достижения своих целей читать ваши документы должны дать вам прилив гордости и, действительно, счастье. До тех пор, как вы помните положительный эффект, что технологии могут оказывать на жизнь людей, когда вы создаете свои документы, которые вы можете общаться более эффективно, поскольку вы будете счастливы в коммуникативный процесс. Протяжении всего жизненного цикла документации, вы должны стремиться поддерживать связь с коллегами, как можно чаще (если применимо). Пусть прочтут ваш документы, слушать их критику и корректировать свои документы (если вы не можете утверждать свой угол!). Технические автором уделяется общаться, убедитесь, что вы делаете, и никогда не забывать, почему ваш общаются, и который, в документах themselves.Common ошибки, чтобы избежать makingWhen создания технических документах есть ряд фатальными недостатками вы можете сделать. Хотя далеко не исчерпывающий, в этом разделе содержится информация о некоторых из наиболее распространенных ошибок, новые авторы делают, в надежде, что вы будете избегать их тоже: Быть покровительственно - Хотя техническая документация должна быть четкой, она никогда не должна покровительственно. Вы не создавать документы быть прочитан дебилы но потребители и клиенты. Вы всегда должны написать уровня квалификации вашей аудитории, но независимо от того, какие технические люди находятся на уровнях, они не дебилы. Даже дети, обижаются, когда покровительствуют, не делайте эту ошибку, с теми, кто платит зарплату, ребенок или otherwise.Overuse юмора - Люди не читал технические документы, которые будут развлекать, они читали их в надежде на успешное завершение процесса или получения информации. Если она имеет отношение к конечному пользователю, избегать юмора, где это возможно. Если вы пишете книгу, тонкий и хорошо. Если вы пишете руководство, избегать юмора, как чума, а более часто, чем пользователи не пропустите шутку и в конечном итоге только отвращение покровительственно идиот, что написал documentation.Inconsistency - Даже на стадии разработки, вы должны убедиться, что все элементы использовать в вашем документе, являются последовательными. Это относится как к 'тон' этого документа в качестве макета для этого. Обеспечить последовательное использование чувств (первые лица и т.д.), а также макет страницы, нумерация страниц, элементов, верхние и нижние колонтитулы и всех других текстовых elements.Proof читать - К концу создания часть технической документации, вам, вероятно, надоело его из виду. Это не имеет значения. Важно то, что листьев Вашего дома или офиса, является точной. С этой целью доказательство прочитал документ во всех его проектах, а до него распространяется доказательство прочитайте его снова и снова, и снова. Никогда не следует полагаться на заклинания шашки (они никогда не работают) и если вы можете избежать этого, не следует полагаться исключительно на свои собственные суждения. Получить документ прочитан как много пар глаз, насколько это возможно до распределения, в конце концов, они могли бы место единственное, что вы пропали без вести в творении process.Conclusion / Shameless Self promotionTechnical не в письменном виде независимо от того, что вы можете думать, легкая работа. Она требует знаний, терпения и очень странная смесь навыков. Так же, как любую другую работу, вы можете узнать, как это сделать, но даже в учебе не обязательно сделает вас хорошо получается. Чтобы быть хорошим техническим автором, вы должны быть еще анального творческих, коммуникативных сосредоточено еще и гибкий эксперт. Это, как вы, вероятно, может себе представить, это не простая задача. Хотя вы можете думать, создание технической документации легко, создание точной, последовательной и своевременной документации высокие коммерческие стандарты исключительно трудной роли. Независимо от вашего бюджета, в конечном счете это обеспечит значительную рентабельность, если вы нанимаете специалиста. В конце концов, они смогут делать в дни, что вы разорвали волос наши попытки выполнить в неделю, если не months.About AuthorOver лет Mike Kemp был использован как независимый ИТ-журналист (работал таких изданий, как The Register, Namesfacesplaces, безопасности и Focus Packetstorm), копирайтер, видеоигры дизайнера, Security Auditor, веб-дизайнер, дизайнер и ИТ-тренер. Он работал в различных независимых и постоянных позиций как для небольших (например, два человека и собака) многонациональными компаниями и организациями по всей Великобритании и Европе. Когда не работает на различных статей, книг, учебных пособий, а также различных других копия для клиента, Майк обычно можно найти трудящегося по целому ряду неопубликованных романов. Он имел несколько коротких сценариев производится независимыми компаниями производства, и в настоящее время работает над несколькими scripts.Mike длиной основной функцией жизнь счастливо в ужасно
Статья Источник: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Вебмастер получить html-код
Добавить эту статью на Вашем сайте прямо сейчас!
Вебмастер представить свои статьи
Не требуется регистрация! Заполните форму и ваша статья в Messaggiamo.Com каталог!
