Download Article
Download Article
- Preparing To Write Instructions
- Writing the Instructions
- Laying Out the Instructions
- Finishing the Instructions
|
|
|
A set of instructions should help a reader accomplish a task quickly, efficiently, and successfully. It’s important to provide every detail. Omissions or mistakes may frustrate a reader. Use the following guidelines to help you write a set of instructions.
-
The first thing to do when writing instructions is to know your audience. Who are you writing for? Are these people experts or novices? Knowing your audience helps you choose your words, your level of detail, and the way you structure the instructions.[1]
- For example, if you were explaining how to bake a cake to a professional chef, you wouldn’t have to explain how to fold in the ingredients, why it’s important to bring the eggs to room temperature, or the difference between all-purpose and self-rising flour. If you were explaining this to someone who doesn’t know how to cook, these definitions and explanations may make the difference between a good cake and a bad cake.
- Err on the side of caution and don’t treat the audience as an expert. This ensures your instructions are always clear and able to be followed.
-
Before you begin, you want to make sure you state clearly what is required to successfully complete the instructions. This might be a list of ingredients or a group of tools.[2]
Advertisement
-
One great way to get clear instructions is to go through the process yourself. This way, you can write down specific steps. If you try to do something from memory, you may not remember everything. Then have someone else perform the task. Ask them for feedback about any confusing or unclear steps.
- Be careful not to leave something out. If you skip important steps, you make it impossible for the reader to complete the task. Also make sure you don’t write the steps out of order.
- For example, if you say, «Mix the ingredients with a mixer. Place in the oven at 350 degrees,» the reader may think you place the mixing bowl in the oven.
Advertisement
-
Effective instruction is simple. Don’t use long, involved paragraphs. Instead, use short, clear sentences, bullet points, and visual aids.
-
Instructions should be full of active, descriptive words. Start your steps with action verbs. This gives the reader a clear action to perform. Each step should read as a command and use the imperative mood.[3]
- When defining or explaining, use as much descriptive language as possible.
- For example, say «Add two eggs» instead of «Two eggs should be added to the cake mix.»
-
When you include additional information, make sure that you are including only what is necessary. Ask yourself, «Does the reader need to know this definition to understand the instructions?» or «Does the reader need this tip to successfully complete this task?»[4]
- Refrain from adding unnecessary information. Unneeded definitions, tips, steps, or information can confuse your readers, making it difficult to follow the instructions.
-
When writing instructions, you should address the reader. Do this using the word «you.» This helps lead the reader personally through the steps.
-
When writing instructions, be as specific as possible. Outline exactly what they do. This includes which way they turn a wrench, how many feet they walk, or what the consistency of the cake should look like when they are done.
- Give all measurements exactly. If someone needs to cut off 5/8-inch of a board, say that.
- For example, if you are baking a cake, don’t wait until step 4 to say, «Before mixing the ingredients, sift the flour and bring the eggs to room temperature.»
-
Transitions help connect the steps to each other. They also help relate the ideas. In instructions, you will use sequence and time transitions. This helps the reader understand the step-by-step instructions.[5]
- Some common transitions are: first, next, then, finally, after, before.
Advertisement
-
Before you start detailing the instructions, you need to give the reader a brief introduction. This introduction explains what the reader should be able to do after the instructions. It also provides an overview of the procedure. This should be written in clear, plain language.[6]
- State the purpose of the instructions, who should read the instructions, and what situation might need the procedure.
- You can talk about what the procedure doesn’t do.
- You can also provide background information in the intro.
- The introduction can mention any warnings or important information that is needed before the reader begins the process. But remember most people will skip the intro, so don’t put anything important in the introduction that you don’t put somewhere else.[7]
- For example, «These instructions provide information on how to bake a chocolate cake. The first section explains how to combine the wet and dry ingredients, and the second section explains how to bake properly.»#Place the steps in sequential order. Instructions need to be in a specific order. The tasks should logically follow one after another. Step 1 has to be completed before you can move on to step 2. Organization is pivotal for writing instructions.[8]
- If it doesn’t matter which order something is done in, start with the most important.
-
Instructions are made up of sequential interrelated tasks. Before you start writing your instructions, you have to decide which steps are prerequisites. This means that you have to decide what has to be done first to complete the overall task.
- For example, if you are baking a cake, you have to heat the oven, mix the ingredients, and make the frosting before you can complete the cake.[9]
- For example, if you are baking a cake, you have to heat the oven, mix the ingredients, and make the frosting before you can complete the cake.[9]
-
Most instructions contain multiple tasks that must be completed for the procedure to be finished. Organizing the instructions into separate parts for each task helps the instructions read clear and as simply as possible for the reader.
- For example, if you are working on a car, there are different things you have to do before getting to the engine. You have to place the car on a jack, remove other car parts, or remove covers. Each of these tasks require their own sets of instructions. You should break each task down into a separate part with its own unique set of instructions.
- These parts, just like the steps, go in sequential order. You can’t remove the engine cover before jacking the car or removing the part blocking it. Parts should be listed in the order that they need to be completed.
- Try to keep each task around 10 steps. If you go over 10 steps, find another task or part to break the procedure into.
- This helps people be able to go back and track their progress. They will know when they have successfully completed a part. Additionally, if they made a mistake, they can go back and fix it without having to redo the entire set of instructions.
-
To help the reader understand the instructions, label each section of the instructions clearly. The heading of the task should summarize what that specific task or part covers. The reader should understand the task they will learn how to do before they begin.[10]
-
The sentences for the steps should be short and only include one step per sentence. This ensures that you break down the task into separate actions instead of making each step with multiple actions.
- If a step has a related action that must be completed together, explain them in their sequence in the same sentence. For example, «Before pouring the cake in the pan, coat the pan with cooking spray» or «Coat the pan with cooking spray. Then pour the cake into the pan.»
-
One important key to instructions is helping your reader track his or her progress. Provide substeps that allow them to see they have done something correct. It might look like this: «When you have ___________, you will see _________.»
- For example, «When the cake is done, insert a toothpick into the middle. If the toothpick comes out clean, the cake is done.»
-
For some steps, there might be multiple ways of doing the same thing. Make sure to explain the different ways the step can be accomplished.[11]
- If there are conditions which make one step better in a certain situation, make sure to discuss that.
- If one step is easier, cheaper, or more effective, make sure to explain that.
-
For some procedures, you may need to break it down further with substeps. Substeps should only be used if they are too small to be considered their own step. Substeps help break down the step into separate parts or sequences of events.[12]
- Add supplementary information into the substeps. This information gives you further detail about the step, such as what something might look like before and after or why the step is important.
-
If there are things the reader needs to know, do, or understand before beginning the task, make sure you tell them that at the beginning of the step.[13]
-
Think about places where your readers might run into problems. Then offer troubleshooting advice. You can also provide examples of things that might go wrong if they have completed a step incorrectly.
- This step is extremely important. If you have completed the instructions yourself, you will already know where you might encounter problems. That’s why it’s important to go through the process as you are writing the instructions.
-
This is very important. Some instructions are not complete when the last nail is hammered or the cake comes out of the oven. Think about what else the person needs to do. If you can think of a «Now what?» you still have other steps to add.
Advertisement
-
When writing instructions, make sure to format them clearly. This helps the reader understand how to read the instructions and not get confused.
- Use a headings to label each discrete part of the instructions.
- Use numbers when listing the steps in order.
- Use bullets to list alternatives, additional information, or anything else under the steps.
- Visually separate the steps. Place a space between the steps to show a difference.
-
The title of the instructions should give an exact preview of what the instructions will explain.[14]
- For example, «Instructions for Baking an Eggless Chocolate Cake» is much more specific than «Chocolate Cake.»
-
Some instructions require diagrams, pictures, charts, or other visual aids to help. Supplement the instructions with these visuals when needed. The visuals should repeat the ideas in the prose, not present any new information. Visuals are supplement material.[15]
- Make sure visuals are near the prose. It should go above, below, or beside the step.
Advertisement
Ask a Question
200 characters left
Include your email address to get a message when this question is answered.
Submit
Advertisement
Thanks for submitting a tip for review!
References
About This Article
Article SummaryX
If you need to write out instructions for a task, start by performing the task yourself. Write down everything that you have to do in order, and include any specific details a reader might need to know. Start your steps with action verbs like “Add,” “Paint,” or “Cut” so the reader clearly understands what they need to do. Open with an introduction to let the reader know what the instructions are for, as well as anything important they might need to know before they start. Also, include a list of supplies or ingredients the person might need. Keep reading to learn how to identify your audience before you start writing!
Did this summary help you?
Thanks to all authors for creating a page that has been read 160,808 times.
Reader Success Stories
-
Anis Droueche
Mar 13, 2017
«It is really interesting and it helps a lot to make things easy, thanks. »
Did this article help you?
Чтобы дать инструкции, достаточно просто назвать действие, которое мы хотим, чтобы человек сделал.
- Give me those shoes, please. – Дайте мне те туфли, пожалуйста.
Если напротив, что-то делать НЕ нужно, добавляем отрицание перед основным глаголом.
- Don’t call me again! – Не звони мне больше!
Структура
verb without «to» particle
Don’t + verb
Примеры
- Help me get all these clothes into my suitcase. – Помоги мне сложить все эти вещи в мой чемодан.
- Don’t put many books on the shelf. – Не ставь много книг на полку.
- Step this way. – Проходите вот сюда.
- Calm down. – Успокойся.
- Open it, please. – Откройте это, пожалуйста.
- Give me the phone and her number. – Дай мне телефон и её номер.
Сделайте английский частью своей жизни и тогда продвинуться вперёд будет гораздо легче. 🔥🔥🔥 Эффективный для этого инструмент – наш полезный телеграм канал с ежедневными мини-уроками и напоминаниями о занятиях! Занимайся ежедневно хотя бы по 5 минут, чтобы прийти к своей цели с помощью маленьких шагов!
Сделай шаг к своей мечте говорить по-английски свободно.
Нравится статья?
Поддержи наш проект и поделись с друзьями!
Мне нравится переводить инструкции. Более того, я люблю это делать. Это сам по себе увлекательный процесс, который позволяет лучше понять принцип работы устройства.
Инструкция к вертолёту МИ-6
Цель: создать понятный и однозначный текст инструкции, которую будет интересно и просто читать.
Вообще говоря, создание инструкции — это не перевод, а локализация. “Переводы” мы все видели и прекрасно знаем, что такие инструкции читать трудно, а вот запутаться или понять что-то неправильно очень легко. Кстати говоря, именно поэтому я предпочитаю читать инструкции на английском — слишком уж многие экономят на переводе. Качество закономерно страдает: если заказчик постоянно урезает бюджет, устанавливает трудновыполнимые сроки или нанимает подозрительно дешёвую команду, то качество перевода буден крайне низким.
Эталонно низкое качество перевода
Если же заказчик достаточно дальновиден, чтобы сполна оплатить качественную работу, выделить уместные сроки, предоставить необходимую информацию и обратиться к грамотным спецам, то он по праву заслуживает порядочно выполненной работы.
А как, собственно, написать эту порядочную инструкцию? Вот несколько правил и рекомендаций:
Читаем всё!
До начала работы над переводом необходимо прочесть инструкцию полностью. Можно сразу же отмечать спорные или непонятные моменты, чтобы разобраться с ними по ходу прочтения.
Терминология — называем вещи своими именами.
Для каждой инструкции и каждого устройства необходимо выработать особую терминологию. Некоторые органы управления можно назвать клавишами, кнопками, рычагами, переключателями, выключателями, курками и ещё как-нибудь. Необходимо сохранять терминологию и не называть второй раз клавишу кнопкой, а переключатель рычагом. Кнопка включения не должна стать кнопкой питания, кнопкой выключения или просто выключателем по ходу инструкции.
Изучаем внешний вид хотя бы по фото, чтобы визуально представлять прибор.
Если устройство включается классическим переключателем, то не стоит называть его “кнопкой”. Знание внешнего вида позволит правильно подобрать термины для описания органов управления и различных узлов.
Минус один к уровню компетенции — пишем просто.
Если устройство является классическим представителем “бытовой техники” или “потребительским товаром”, то следует избегать сложных терминов и профессиональных жаргонизмов. Такую инструкцию нужно писать максимально доступным языком, использовать короткие и простые предложения.
Если к прибору отлично подходят слова типа “узкоспециализированный”, “промышленный”, “профессиональный”, то, вероятнее всего, эксплуатироваться он будет специалистами. Здесь уже можно использовать специфичные термины и сложные предложения, но без фанатизма.
Помните: необходимо всегда упрощать текст, если есть такая возможность.
Прочь от номерклатуры — пишем просто.
Тактовые кнопки с очень малым шагом нажатия можно назвать псевдосенсорными, квазисенсорными или просто тактовыми. Индикаторы могут быть световыми, стрелочными, звуковыми, экранными и прочими. Переключатели могут включать, переключать или выключать, могут иметь подсветку, многоцветную индикацию и несколько позиций. Регуляторы могут быть поворотными или ползунковыми, с фиксацией по центру, шаговой фиксацией или без фиксации, со встроенным выключателем и без такового. Поворотные регуляторы могут быть цифровыми и бесконечными, аналоговыми или оптическими. Всё это обычному потребителю не надо знать!
Если точнее, знать, за что отвечает каждое положение переключателя, потребителю надо. Но это не означает, что нужно каждый раз описывать все особенности органа управления и регулярно городить что-то вроде “переведите ползунковый регулятор температуры “TEMP” с шаговой фиксацией в положение 125”, если можно написать “установите регулятор “TEMP” в положение 125”.
Эту инструкцию можно улучшить и упростить
Соблюдаем масштаб в размерах и последствиях — снова о терминах и жаргонизмах.
Тактовую кнопку с диаметром в один сантиметр можно назвать только кнопкой. Пятисантиметровую кнопку, которую надо утопить на пару сантиметров для включения, более уместно назвать клавишей.
Переключатель диапазонов радиоприёмника таки переключает режимы. Здоровый переключатель режима работы станка более уместно назвать рычагом.
Освещение комнаты активируется выключателем. Подача электроэнергии в квартиру — рубильником.
Небольшой рычаг — ручка или рычажок.
Это было о масштабе размеров. А теперь — о масштабе последствий.
Лампочка на телевизоре — индикатор. Лампочка тех же размеров, уведомляющая о неисправности, — сигнальный индикатор.
Выбор режима — кнопка 1см. Сброс всех настроек — клавиша 1см.
Три одинаковых выключателя в ряд: два управляют секциями, это выключатели, а тот, что выключает вообще всё — тумблер.
Иначе говоря, органы управления, которые имеют более важное значение и требуют повышенного внимания, стоит называть более солидно.
Сами-то понимаете? Даём ознакомиться неспециалисту.
Готовую инструкцию желательно дать почитать кому-нибудь со стороны. Если у постороннего человека, который и прибор-то в глаза ни разу не видел, регулярно возникает непонимание, то материал надо дорабатывать.
Строго переводим отказ от ответственности и юридически значимые моменты.
Я думаю, вам знакома шутка про американку, которая постирала своего кота в машинке, а затем вкатила иск компании-производителю и, якобы, с тех пор в каждую инструкцию вводится соответствующее предупреждение. Так вот: единственный раздел инструкции, в котором уместно использовать юридические термины и сложные конструкции в предложениях — это раздел гарантии и отказа от ответственности. Это как раз та самая часть материала, которую необходимо переводить буквально, а не в соответствии с литературными представлениями переводчика о прекрасном. Именно в этом разделе инструкции можно встретить различные глупости, например (для СВЧ печи): «Не предназначена для живых животных», «Не использовать для приготовления живых животных», «Не использовать в качестве светильника», «После разогрева продукт может быть горячим». Оставлять эти дурацкие инструкции необходимо с обязательной пометкой заказчику, что лучше бы это убрать. Если заказчик согласен, то он опустит эту часть, но не самодеятельничайте.
У вас неисправность? Советуем что-нибудь предпринять…
Раздел “поиск и устранение неисправностей” позволяет всегда оценить уровень дипломатичности составителя инструкции и адекватность человека, который работал над переводом:
— У меня проблема: прибор не включается.
— Есть решение: подключите устройство к электросети.
— Ты меня дураком сейчас назвал? Сам дурак!
Обычно в разделе указываются очевидные неисправности и не менее очевидные способы их решения. Это вина оригинального составителя инструкции и влияние той самой предприимчивой хозяйки кота. Чтобы не выставлять покупателя полным идиотом, желательно сгладить очевидное решение:
— У меня есть проблема: прибор не включается.
— Есть решение: возможно, нарушено подключение к электросети. Проверьте исправность розетки и осмотрите сетевой кабель на наличие повреждений.
Предлагаемое решение в обоих случаях одинаково, но во втором варианте мы не выставляем пользователя идиотом.
Собственно, руководствуясь этими рекомендациями можно написать достаточно качественную инструкцию.
Лучше маленький лайк и репост, чем большое спасибо в комментах. По этой причине комментарии выключены, а кнопки репостов — вас ждут. Пользуйтесь, прошу 
ЧОУ «Православная школа во имя праведного Иоанна Кронштадтского»
Учитель английского языка: Кириченко ЕВ
«Do you follow?»…
Или как правильно давать инструкции?
-
Инструкции в образовательном процессе.
В процессе обучения учитель часто даёт инструкции обучающимся. Школьнику необходимо умение внимательно понимать задание и четко действовать в соответствии с ним.
-
Зачем нужны инструкции?
Подписать листок, указать вариант, выполнить домашнее задание на листочке, а не в тетради – наиболее частые и наиболее простые указания, которые мы выдаём учащимся. И всякий раз удивляемся тому, что в классе обязательно найдётся несколько человек, которые не следуют им. Неумение читать и понимать инструкции являются большой проблемой при сдаче ЕГЭ и ОГЭ: часто это одна из основных причин ошибок в тестах.
Поэтому формирование умения следовать указаниям – является ключевым моментом в обучении.
Умение работать в соответствии с инструкциями:
— экономит время;
— обеспечивает безопасность;
— является необходимым элементом не только в профессиональной или учебной деятельности, но и в повседневной жизни;
— чёткие и ясные инструкции, наряду с групповыми формами работы, являются необходимым элементом смыслового чтения.
Инструкции могут быть устными или письменными (иногда в виде последовательных рисунков или символов). Поэтому развивая умение следовать инструкциям, мы обучаем ребят «осмысленному» слушанию, осмысленному чтению и, собственно, действию по алгоритму.
-
Эффективные инструкции.
Несколько рекомендаций, которые помогут сделать ваши инструкции более эффективными:
1. Стойте всегда на одном и том же месте, когда даёте инструкцию.
2. Чётко формулируйте указания.
3. Не повторяйтесь.
4. Делайте паузу между указаниями.
5. Говорите спокойным голосом, не повышайте интонаций.
Ребята очень быстро привыкают к установленному порядку, эффективность урока, как правило, повышается, снимаются вопросы дисциплины, повышается вовлеченность учащихся в урок. Как только дети сознают эффективность деятельности по алгоритму, исчезает проблема несамостоятельности при выполнении лабораторных работ, решении задач, работе с текстом. Известно, что в любом деле сначала осваиваются алгоритмы выполнения того или иного процесса, и только потом становится возможным творчество. Работа по алгоритму, инструкции позволяет формировать компетентность в деятельности, т. е. ребёнок, пользуясь предложенным алгоритмом, знает, что он должен делать.
-
Инструкции на уроке английского языка.
Подробнее хотелось бы остановиться на умении давать инструкции на уроке английского языка. Часто ли вам приходится слышать на занятии, что ученикам непонятно задание, или по окончании задания замечать, что упражнение сделано не в том порядке? А может катастрофически не хватает времени на уроке, хотя в плане всё было расписано поминутно?
В чем скрывается недочет? Как показывает практика, зачастую проблема в неправильной или некорректной формулировке инструкций, то есть объяснении заданий. Инструкции являются одним из главных критериев успешности проведения урока на иностранном языке.
Ниже короткая статья под названием Good Instruction-Giving in the Second-Language Classroom (Jimalee Sowell Cote d’Ivor).
Если вы только начинаете преподавать, то есть смысл продумывать и прописывать инструкции в плане. Если вы давно преподаете, то иногда тоже стоит подготовить инструкции, особенно в случае задания в несколько этапов.
-
Советы при объяснении заданий на уроках английского языка.
Убедитесь, что все вас слушают.
Разделите инструкции на короткие и четкие этапы. См скриншоты.
Показывайте, что делать каждый раз, когда это возможно. В парной работе разыграйте это самым сильным студентом, после попросите 2-х студентов это сделать. В индивидуальной — дайте свой пример.
Используйте ударение, когда даете инструкции: “Write down three(!) questions” — на слове three. Покажите 3 пальца.
Установите лимит времени, чтобы студенты знали, сколько у них минут на выполнение задания.
Проверьте, что поняли студенты с помощью concept-check questions:
“How many students are you going to interview?”, “Who is going to speak first?”, “How many questions are you going to write?”
Во время выполнения задания проверьте, что студенты делают то, что надо. А если делают не то, скорректируйте спокойно и без раздражения.
-
Неэффективные формулировки на уроках английского языка:
-
Yeah, for the next exercise, you have to do pretty much the same as you’ve done for the other one.
-
You’ve got to listen to these and determine which one sounds ____which one sounds____.
-
What I want you to do now , we don’t have much time but we’ll see if we can do it. What I want you to do is to go….
-
It’s a real interview, an actual interview, it really happened. We’re going to seeifwe can answer, you don’t need to write, we can see if we can answer any of these questions.
-
How about we get one question, if we can, are you Ok with that, if we can get question from each of you, no, no, that’s ok, just one question.
Вот ещё несколько примеров того, как многословны бывают учителя:
Звучит нелепо? Но это реальные инструкции, которые говорят учителя. Часто мы просто не слышим себя. Можете их поправить? (См. ключи в конце статьи)
-
Эффективные формулировки на уроках английского языка:
2.4 Рефлексия: А как вы объясняете задания на своих уроках?
Таблица с вопросами ниже поможет вам проанализировать, насколько эффективно вы даете инструкции своим ученикам.
-
Умение давать инструкции — важнейший навык.
Умение следовать полученной инструкции – это и важный этап в развитии школьника, в проявлении его волевого поведения, и очень важный учебный навык. Инструктирование — один из видов устного изложения материала, предполагающий постановку и четкое достижение задач в ходе обучения, используемый для организации деятельности учащихся в процессе занятия.
Умение давать инструкции на уроке английского языка — важнейший навык, который влияет на ход урока.
Ключи*
|
Wordy Instructions |
Concise Instructions |
|
Yeah, for the next exercise, you have to do pretty much the same as you’ve done for the other one. |
For the next exercise fill in the gaps again. (fill in the gaps можно заменить любым подходящим заданием) Или Do the same, but… |
|
You’ve got to listen to these and determine which one sounds ____which one sounds____. |
Listen and say / / or / / Listen and colour / / red and colour / / blue |
|
What I want you to do now , we don’t have much time but we’ll see if we can do it. What I want you to do is to go…. |
Two minutes. Please fill in the gaps again (fill in the gaps можно заменить любым подходящим заданием) |
|
It’s a real interview, an actual interview, it really happened. We’re going to see if we can answer, you don’t need to write, we can see if we can answer any of these questions. |
Listen to the interview and answer the questions. Don’t write! |
|
How about we get one question, if we can, are you Ok with that, if we can get question from each of you, no, no, that’s ok, just one question. |
Make one question about…, please. или One question from each of you. |
Документация на английском языке: советы начинающим
26.03.2014
Сегодня мы подвели итоги конкурса «Конёк документатора». Победители награждены призами, а лучшие работы мы опубликуем на нашем сайте.
Представляем вашему вниманию работу, занявшую 1 место: «Документация на английском языке (советы начинающим)». Автор – Софья Новикова, технический писатель в компании «Икстенс», г. Новосибирск. Пунктуация и орфография автора сохранены.
Ищите, кому доверить Ваши задачи по переводу документации на английский или с английского языка? Специалисты компании «ПроТекст» будут рады помочь! Подробности на этой странице.
Так получилось, что весь мой опыт работы техническим писателем приобретался в компаниях, работающих с иностранными клиентами. Поэтому писать документацию мне приходилось преимущественно на английском языке. Хотелось бы поделиться опытом с теми техническими писателями, кто только начинает писать англоязычную документацию либо переводить русскоязычную документацию на английский язык. Конечно, хорошее знание английского языка – это первое и необходимое требование для достижения успеха, но недостаточное. Умение писать техническую документацию на русском языке так же может оказаться хорошим подспорьем, однако в англоязычной документации есть свои особенности, которые следует учитывать. Я расскажу об основных особенностях, которые мне удалось узнать за время своей работы.
Стандарты
Первый совет: перед началом написания документации ознакомиться с существующими стандартами.
Правильное написание элементов интерфейса
Прежде всего, стоит ознакомиться со стандартными наименованиями элементов интерфейса на английском языке и правилами их описания. Например:
- «Check box» пишется раздельно, «Drop-down» – через дефис, а «ToolTip» – слитно
- «Click the button», но «Press the key»
- «Select the check box», а не «Check the box»
Самый лучший источник информации по стандартам – Microsoft Manual of Style, на данный момент актуально четвёртое издание: http://www.microsoft.com/learning/en-us/book.aspx?id=15053. Этот документ регулярно переиздаётся, так что следите за обновлениями.
Стандартные названия глав документации
Если вы пишете руководство пользователя (User Guide), разумно использовать в структуре названия глав, привычные для пользователей, говорящих на английском языке. Например:
- Welcome to … (Введение).
- Feature Highlights (Обзор характеристик программного продукта)
- What’s New (Новые характеристики)
- Getting Started (Быстрый старт)
- Restrictions and Limitations (Список ограничений)
- Troubleshooting Tips (Решение проблем)
Набор глав может и отличаться от набора приведённого выше. Советую найти в интернете руководство к какой-либо известной программе, разработанной иностранной компанией, и обратить внимание на названия её глав. Ещё лучше – наметить структуру документа заранее и посоветоваться с носителями языка (если, конечно, есть такая возможность). К примеру, иностранные партнеры нашей компании очень помогли мне в построении нужной структуры документов и выборе нужных названий.
Стиль документации
Требования к стилю изложения англоязычной документации – такие же, как и к стилю изложения русскоязычной документации: структурированность, строгость, детальность, лаконичность, дружелюбный и авторитетный тон. Но следует помнить, что недостаточно хорошее знание английского языка может привести к невольному появлению чересчур авторитарного тона или напротив — чересчур фамильярного. Неаккуратный перевод сразу бросается в глаза читателям, говорящим на английском языке и снижает впечатление от технической документации.
Как называть пользователя
Лучше всего обращаться к пользователю во втором лице, в повелительном наклонении:
- Click the «Add» button.
- Please note that the file should have a correct format.
- This window allows you to configure the main settings of the system.
Однако, если требуется написать о пользователе в третьем лице (к примеру, при описании действий пользователя в инструкции дял администратора сайта), то следует избегать местоимения «he», т.к. оно указывает на половую принадлежность. Лучше употреблять существительные: «user», «administrator», «operator». Если не удаётся избежать употребления местоимения третьего лица единственного числа, то следует применять сочетание «he/she». Например:
- When the user submits the form, he/she gets the access to all the system functionality.
Should or Must?
При описании действия, которое пользователь должен произвести, используются модальные глаголы «should» и «must». Грань между их значениями весьма тонка. Однако в обращении к пользователю следует по возможности избегать словосочетания «you must» , т.к. это звучит излишне авторитарно. В большинстве случаев предпочтительно словосочетания «you should», т.к. это более вежливая форма указания.
- You should avoid using long file names for better work with the system.
- For correct work of the program you should previously install the special software.
Однако, когда требуется особо подчеркнуть необходимость действия (для критичных действий) – допустимо употребление словосочетания «you must».
- You must fill all the required fields to continue working.
Артикли
Артикли – это важный элемент любых англоязычных текстов, и русскоговорящие писатели довольно часто допускают ошибки в их использовании. Здесь, конечно, можно дать общий совет – изучать правильное употребление артиклей в английском языке. Но хочется особо упомянуть два момента связанных с артиклями в технической документации:
Артикли в заголовках
В заголовках технической документации обычно используется капитализация всех значимых слов. Артикли в заголовках используются редко, но если же используются — то никогда не пишутся с заглавной буквы, если только не используются в начале заголовка. Например:
- How to Add a New File
- Main Concepts of the System
Артикли в описаниях управления элементами интерфейса
Если вы описываете действие с именованным элементом интерфейса, например, нажатие на кнопку «Send», допустимы два варианта:
- С использование названия элемента («button») – в этом случае используется артикль «the» перед именем элемента:
Click the «Send» button. - Без использования названия элемента – в этом случае артикль не нужен:
Click «Send».
Употребление иностранных слов
Если проявить неаккуратность при использовании терминологии, пользователи могут счесть Вас недостаточно квалифицированным специалистом. Вот некоторые правила, которых следует придерживаться в использовании англоязычной терминологии:
Специальные термины
Обращайте внимание на перевод специализированной терминологии. Вот примеры переводов специализированных терминов: операционная система – operating system (и никак иначе, не operational system, operate system и т.п.), информационная система – information system.
Если возникают сомнения в использовании того или иного термина – сверяйтесь со словарём или поищите в интернете аналогичный пример в англоязычной документации.
Ложные друзья переводчика
Имейте в виду наличие так называемых «ложных друзей переводчика». Это слова в иностранном языке, которие похожи на слова в родном языке, но имеют другой смысл. Вот примеры таких слов:
- accurate – точный
- activity – деятельность
- actual – действительный, реальный, фактически существующий
- complex – сложный
- concurrent – одновременный
- control – управлять
- data – данные
- audience — аудитория
В заключение, хочется посоветовать, при наличии возможности, давать свою документацию на проверку носителям языка – это помогает прояснить множество вопросов и существенно улучшить качество документации.
Тэги: английский язык, конкурс, советы, стиль