Пишем техническую документацию – грамотно и четко

Разделы: Иностранные языки

Ключевые слова: английский язык

В данной разработке мы познакомимся со способами технического письма для студентов технических колледжей, и сразу, я хочу привести, в качестве примера, краткий сценарий, подчеркивающий важность владения техническим письмом.
Допустим, к вам поступила задача познакомить англо-говорящего пользователя с языком C#. Вы, как исполнитель, решаете начать знакомство со следующего кода:

using System;
class Hello
{
static void Main() {
Console.WriteLine("Technical writing is an important skill");
}
}

Следовательно, вам потребуется, четко формулируя функции переменных, объясняя их роль в коде на доступном, но технически аргументированном языке, на простом примере познакомить заказчика с языком C#.

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

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

Примеры инструкций для целевых аудиторий.

1. Стандартное руководство пользователя

Share Your Mobile Network with Other Devices.

You can use Wi-Fi hotspot or Bluetooth to share your mobile data with other devices.

Use Wi-Fi hotspot to share mobile data: Open Settings and go to Wireless & networks >Tethering & portable hotspot > Portable Wi-Fi hotspot > Configure hotspot. Set the hotspot name, encryption type, and password for the Wi-Fi hotspot, then touch Save and enable the hotspot to use it.

2. Инструкция для любимого дядюшки Пети

My dear Uncle Peter! It's pretty simple to use your mobile phone's data allowance for other devices using your phone as a Personal Hotspot. The process is referred to as creating a mobile wireless hotspot, though no heat or fire is involved.
To set up a mobile hotspot with your phone Uncle, heed these steps:

1. Turn off the Wi-Fi radio.
There's no point in creating a Wi-Fi hotspot when one is already available.

2. Plug the phone into a power source.
The mobile hotspot feature can draw a lot of power.

3. Open the Settings app.
It's found on the apps screen. Some phones may feature a Mobile Hotspot or 4G Hotspot app. If so, open it instead.

4. Touch the More item in the Wireless & Networks section, and then choose Tethering & Portable Hotspot.
The Tethering & Mobile Hotspot item might be found on the main settings app screen. You may see text describing the process. If so, dismiss the text.

5. Touch the box to place a check mark by the Portable Wi-Fi Hotspot or Mobile Hotspot item.
The hotspot is on, but you may want to confirm some of the settings. If the hotspot doesn't come on or the item is disabled, your phone is incapable of creating a Wi-Fi hotspot or that feature is unavailable under your data subscription plan.

6. Choose the Set Up Wi-Fi Hotspot item to give the hotspot a name, or SSID, and then review, change, or assign a password.
Touch the fields on the Set Up Wi-Fi Hotspot screen to assign a name and password. Touch the Save or OK button to set your changes.

When the mobile hotspot is active, you see the Hotspot Active notification icon, similar to the one shown. You can then access the hotspot by using any computer or mobile device that has Wi-Fi capabilities.
Enjoy!

Прежде чем начать писать:

  1. Спланируйте, какую информацию вы хотите включить в свой технический документ. Чем больше вы планируете его содержание и структуру, тем быстрее вы добьетесь прогресса.
  2. Проведите свое исследование - чтобы написать убедительный документ, вам нужно подкрепить свои выводы приведенной статистикой, мнением экспертов и тематическими исследованиями.
  3. Определитесь с вашей структурой. Постарайтесь структурировать ваш документ так, чтобы он хорошо отображал и располагал информацию в логическом порядке.
  4. Составьте примерный план того, насколько объемный будет ваш документ, включая количество слов. От 2000 до 4000 слов в документе, который содержит достаточно деталей, чтобы быть полезным предполагаемому пользователю, но при этом его можно будет изучить за один присест.

Напишите вступление - сделайте его максимально коротким. Дайте читателю понять, Кто должен это читать и Почему они должны читать это. Если читатель принадлежит к группе «кто», а ваше «почему» решает его проблему, то вы только что привлекли его внимание.

Congratulations! You are now ready to begin using Space Explorers' innovative programs in your classroom. Universal program access is a subscription service designed to stimulate your students' interest in space and science. Your class can participate in a mission to space, perform International Space Station experiments, and explore the basics of our solar system from your classroom or computer lab. Universal access provides school-wide usage of all the pages on our website for every teacher on your campus, using their own unique usernames and passwords. One teacher on a Universal campus is designated as the administrator. This individual may sign up other teachers on their campus and receives this manual, e-mail notifications of special events and contests, and any additional purchased materials such as kits.

The Universal subscription includes the following components:

Будьте прямолинейны - читатели технического письма не ищут изменяющего их жизнь литературного опыта. У них есть проблема. Они хотят, чтобы вы решили ее. Если это инструкция или практическое руководство, используйте императивный тон письма. Если это технический анализ или отчет для начальника, пропустите ненужные слова.

Introduction

Thank you for selecting the HP Personal Media Drive. This drive is an external hard disk drive with a large capacity designed to quickly and easily store and transfer media files such as digital photos, music, video, and other important files.

The HP Personal Media Drive connects and disconnects easily from a USB 2.0 connector on the front or back of most PCs.
For some HP PCs, the HP Personal Media Drive is designed to fit inside a horizontal or vertical drive bay.

Your HP Personal Media Drive comes with backup software (select models only) that is compatible with most Microsoft® Windows® Operating systems.

Грамотно используйте пространство в письме. Если бы я расположил данные рекомендации, вместо списка с абзацами, в один длинный текст, вы бы сразу же его пропустили. Разбивайте содержание как можно чаще. Используйте заголовки, подзаголовки и вставки, чтобы объединить ваше руководство в простые для восприятия фрагменты. Полезно включить содержание (оглавление), чтобы при необходимости люди могли перейти к интересующему их разделу. Мозги любят порядок и пространство. Небольшие абзацы хороши. Нумерованные или маркированные списки великолепны. Если требуется, при маркировке абзацев, используйте цифры; в противном случае используйте маркеры.

Beer Pizza

This is a very filling pizza that my husband loves. My mom and dad use to make it when I was young, and it was always a treat.

Ingredients

  • 1 tablespoon olive oil
  • ½ pound pepperoni sausage, diced
  • 1 pound bacon, diced
  • 1 (4 ounce) can sliced mushrooms, drained
  • 1 onion, chopped
  • 1 green bell pepper, chopped
  • 1 (28 ounce) can tomato sauce
  • 1 cup beer
  • 1 clove garlic, minced
  • 1 teaspoon dried oregano
  • ½ teaspoon dried thyme
  • ½ teaspoon salt
  • 2 unbaked pizza crusts
  • 1 (8 ounce) package shredded mozzarella cheese

Directions

  1. Preheat oven to 450 degrees F (230 degrees C).
  2. Heat the oil in a skillet over medium heat, and sauté the pepperoni and bacon until evenly browned. Mix in the mushrooms, onion, and green pepper. Cook and stir about 5 minutes, until tender.
  3. In a medium saucepan over medium heat, mix the ingredients from the skillet with the tomato sauce and beer. Season with garlic, oregano, thyme, and salt. Allow the mixture to simmer for about 15 minutes, until slightly thickened. Spread over the 2 pizza crusts, and top with cheese.
  4. Bake 20 to 25 minutes in the preheated oven, until the cheese is melted and the crust is golden brown.

Прежде чем отправить вашу работу заказчику, опробуйте ее на ком-либо. Это хорошая идея, чтобы проверить ваши технические документы, особенно если это касается инструкций. Попросите своего однокурсника. Указания должны быть достаточно ясными, чтобы потенциальный пользователь мог им следовать. И ваш однокурсник, в качестве редактора, может указать на неоднозначные инструкции или неясные объяснения, которые вы, возможно, не обнаружили.

Далее, я рад предложить вашему вниманию работу со статьей, состоящей из нескольких текстов "How to Create a User Manual" (Приложение 1), где вы вместе со студентами тщательно разберете тему создания качественного руководства пользователя; и сборник дидактических материалов (Приложение 2) содержащий размножаемый раздаточный материал. Выбор методических приемов по выполнению заданий по карточкам остается за преподавателями, в зависимости от ситуации в их группах.

Список литературы и интернет-ресурсов

  1. HP Personal Media Drive User's Guide
  2. Dan Gooking. Android Phones & Tablets For Dummies (For Dummies (Computer/Tech)) 1st Edition.
  3. http://files.customersaas.com/files/Huawei_P_Smart_(2019)_(Single_SIM)_User_manual.pdf
  4. https://www.dummies.com/consumer-electronics/smartphones/droid/how-to-create-a-mobile-hotspot-with-an-android-phone/
  5. https://jerz.setonhill.edu/writing/technical-writing/instructions-how-to-write-for-busy-grouchy-people/
  6. https://www.wikihow.com/Create-a-User-Manual#tips
  7. https://www.dummies.com/