Що таке технічне письмо? Повний посібник

Коли ви намагаєтеся розібратися з новим гаджетом, ви тягнетеся до інструкції.

Якщо у вас виникають труднощі з налаштуванням програмного забезпечення, ви можете звернутися до сторінок довідки.

Коли ваша машина видає дивний звук, ви гортаєте інструкцію до бардачка.

Все це є прикладами того, що технічне письмо - те, на що ми покладаємося щодня, але рідко про це замислюємося.

За даними Glassdoor, технічний письменник у SpaceX заробляє від $88 000 до $138 000 на рік. 

Проте більшість людей досі не розуміють, що таке технічне письмо.

Це не просто набираю текст. інструкції.

Це не просто перекладаю інженера на зрозумілій англійській мові.

І справа навіть не тільки в тому, що створення посібники користувача або довідкові документи. 

Що ж таке технічне письмо? Чим воно відрізняється від інших видів письма? Які існують його форми? Як стати технічним письменником? І як штучний інтелект може допомогти на цьому шляху? 

Про все це та багато іншого ми розповімо в цьому блозі. Давайте зануримося! 

Що таке технічне письмо?

Говорячи неспеціалізованою мовою, технічне написання текстів означає взяти складні та детальні теми і пояснити їх так, щоб будь-хто (з відповідною підготовкою) зміг зрозуміти їх. 

Наприклад, в тому числі:

• Посібники користувача - Той буклет, що йде в комплекті з телефоном? Це технічна документація.
• Документація API - Розробникам теж потрібні інструкції. API самі себе не пояснюють.
• Технічні звіти - Інженери та науковці покладаються на них, щоб ділитися дослідженнями та результатами.

Технічне письмо - це не тільки те, що ви пишете, але й як ви це пишете. Він використовує:

• Наказовий спосіб - Замість "Ви повинні натиснути на кнопку". це просто "Натисни на кнопку". 

• Пасивний стан (коли потрібно) - Якщо неважливо, хто виконав дію, пасивний стан допомагає. "Файл було видалено" працює краще, ніж "Хтось видалив файл" якщо фокус на файлі.

Дехто вважає, що технічний копірайтинг - це написання текстів для SaaS-продуктів або технічних блогів. 

Але справа не в маркетингу чи сторітелінгу. 

Технічне письмо має дуже різні типи (про які ми поговоримо незабаром) - усі з однією метою: представити інформацію в точний, зрозумілий і функціональний спосіб. 

Чим технічне письмо відрізняється від інших стилів письма

Давайте розберемося в шести аспектах, за якими технічне письмо відрізняється від інших стилів письма.

Креативні письменники використовують двозначність або метафори, щоб залучити аудиторію. 

Технічні письменники не прагнуть до двозначності. 

Вони хочуть надати перевагу ясності, а не творчому вираженню, але така природа цієї роботи. 

Чому технічне письмо необхідне в різних галузях

Уявіть собі пілота, який читає цей посібник під час польоту, коли йому потрібно терміново щось зрозуміти:

"Відрегулювати векторизацію тяги для компенсації асиметричної аномалії тяги шляхом застосування протоколу стандартного відхилення 5.3b з урахуванням змінних атмосферної густини"

Або уявіть собі хірурга, який переглядає інструкції до процедури за кілька хвилин до критично важливої операції: 

"Розрізати паралельно фасціальним площинам, враховуючи підлеглі нервово-судинні структури, підтримуючи гемостаз протягом усієї послідовності розтину" 

Навіть якщо вони лікарі або пілоти, які вивчали це все своє життя, вони не захочуть читати це в екстрених ситуаціях. 

Це створює плутанину і розчарування, яких кожен хотів би уникнути незалежно від ситуації.

Давайте розглянемо п'ять основних причин, чому технічне письмо є абсолютною необхідністю: 

1. Зменшення ризиків та дотримання вимог - У таких галузях, як охорона здоров'я, фінанси та авіація, помилки не просто дорого коштують - вони можуть бути смертельними. 
   • Наприклад, Що робити, якщо медсестра неправильно інтерпретує інструкцію з дозування через нечіткі формулювання? Належна документація запобігає цим помилкам. 

2. Збереження та передача знань - Люди залишають роботу, отримують підвищення або виходять на пенсію. Але що відбувається з усіма знаннями в їхніх головах? Вони належним чином задокументовані за допомогою технічного письма. Добре задокументований процес означає, що наступна людина може заступити на посаду, не починаючи з нуля.

3. Задоволеність клієнтів та зменшення витрат на підтримку - Ви коли-небудь намагалися налаштувати новий пристрій, а в підсумку дивилися випадковий відеоурок на YouTube, тому що інструкція не мала жодного сенсу? Погана документація розчаровує клієнтів і обтяжує служби підтримки непотрібними дзвінками. Добре написаний посібник рятує все це. 

4. Правовий захист - Контракти, політики та інструкції з безпеки слугують доказами в суперечках.
   • Наприклад, Якщо на компанію подають до суду за неякісний товар, перше, що перевіряють юристи, - це документація. Чи попереджала інструкція про ризики? Чи були чітко прописані процедури безпеки? Якщо ні, то у компанії проблеми.

5. Підвищення ефективності завдяки стандартизації - Уявіть собі компанію, в якій кожен відділ використовує різні системи для виконання однієї й тієї ж задачі. Одна команда відстежує дані в електронних таблицях, інша використовує спеціальне програмне забезпечення, а третя просто "запам'ятовує". Це безлад. Технічне письмо гарантує, що процеси стандартизовані, повторювані та масштабовані

По суті, технічне письмо допомагає запобігти плутанині, економить час і захищає людей. 

Види технічного письма (з прикладами)

Багато людей чують "технічне письмо" і одразу ж згадайте сухі, роботизовані інструкції з експлуатації - такі, які ніхто не читає, якщо тільки вони зовсім не застрягли. 

Але технічне письмо - це набагато більше. 

Насправді, він існує майже в кожній галузі та існує в багатьох різних формах, кожна з яких слугує певній меті.

Ось шість найбільш важливих типів технічного письма (з прикладами):

1. Технічна документація - Це класичний тип. Він включає в себе посібники користувача, інструкції про продукти та інструкції з усунення несправностей.  
   • Наприклад, Ви щойно придбали новеньку еспресо-кавоварку, і вас збиває з пантелику велика кількість кнопок. Замість того, щоб гадати, ви відкриваєте інструкцію з експлуатації і слідуєте покроковій інструкції, щоб приготувати свою першу чашку.
     
2. Документація процесу - Кожна компанія має робочі процеси, але якщо ці процеси існують лише в чиїйсь голові, це катастрофа, яка чекає на нас. Вони називаються СОП. 
   • Наприклад, Ви повинні зробити фірмову закваску пекарні. Без СОП кожна буханка буде відрізнятися від інших. На щастя, в СОП детально описаний кожен крок - точні вимірювання, час підйому, температура випікання - кожен раз.
     
3. Документація API - Якщо програмне забезпечення - це мозок, API (Application Programming Interfaces) - це нервова система. 
   • Наприклад, Додаток для попутних поїздок потребує даних про трафік у реальному часі, тому він інтегрує API Google Maps. Без чіткої документації по API вони зіткнулися б з нескінченними спробами і помилками.
     
4. Наукові/дослідницькі роботи - Вони написані дослідниками, але мають бути прочитані світом.  
   • НаприкладНове лікування раку виглядає багатообіцяючим, але перед його застосуванням вчені повинні опублікувати дослідження про те, як воно працює, його побічні ефекти та показники виживання. Інші перевіряють ці дані, щоб підтвердити їх.
     
5. Білі книги та тематичні дослідження - Білі книги - це "переконливі аргументи" технічного світу. Тематичні дослідження йдуть далі, показуючи реальні історії успіху з реальними результатами. 
   • Наприклад, Фірма з кібербезпеки попереджає про нову банківську загрозу в офіційному документі. Місяць потому вони поділилися кейсом про те, як їхній інструмент зупинив атаку. Банки починають звертати увагу.
     
6. Регуляторна/комплаєнс-документація - Охорона здоров'я, фінанси та виробництво покладаються на нормативно-правові акти. Комплаєнс-документація допомагає компаніям дотримуватися законів, уникаючи штрафів, судових позовів та суспільних катастроф.
   • Наприклад, Фармацевтична компанія повинна довести, що нове знеболювальне є безпечним, перш ніж продавати його. Вони подають документи з переліком інгредієнтів, дозування та побічних ефектів, щоб уникнути будь-яких юридичних проблем.

Ключові навички, необхідні для написання технічних текстів

Якщо ви коли-небудь вчили своїх бабусь і дідусів користуватися смартфоном, не змушуючи їх відчувати себе дурнями, то ви можете стати технічним письменником, тому що це основна навичка.

Кожній іншій навичці можна навчитися. Ось список навичок, якими повинен володіти технічний письменник:

• Дослідницькі здібності - Вам не потрібно знати все, але ви повинні знати, як знайти точну і надійну інформацію.
  
• Аналіз аудиторії - Знання того, хто ваші читачі, що вони вже знають і чого їм потрібно досягти - ось що робить ваш текст корисним. Тому що те, як ви пояснюєте оновлення програмного забезпечення розробнику, відрізняється від того, як ви пояснювали б це клієнту.
  
• Чітке спілкування/навички простої мови - Технічне письмо - це не про те, щоб звучати розумно, а про те, щоб інші відчували себе розумними. Це означає, що потрібно відмовитися від жаргону, використовувати просту мову і писати настільки зрозуміло, щоб читачеві ніколи не довелося здогадуватися, що ви маєте на увазі.
  
• Інформаційна архітектура - Читачі не завжди читають від початку до кінця, вони сканують. Ви повинні розуміти, як організувати контент за допомогою заголовків, тез і логічної послідовності, щоб інформацію було легко знайти і засвоїти.
  
• Візуальна комунікація - Іноді зображення пояснює щось швидше, ніж абзац. Блок-схеми, анотовані скріншоти та інфографіка можуть спростити навіть найзаплутаніші поняття. Хороший технічний письменник знає, коли писати, а коли показувати.
  
• Володіння інструментом - Знання правильних інструментів прискорює процес. Наприклад, програмне забезпечення для документування включає MadCap Flare або Confluence, а інструменти для проектування - Snagit або Figma.

• Навички редагування та доопрацювання-Перша редакція ніколи не буває ідеальною. Технічні письменники повинні доопрацювати свою роботу для забезпечення ясності, точності та повноти, гарантуючи, що кожне слово слугує певній меті. Йдеться про те, щоб зробити документ якомога простішим у використанні.

Хто використовує технічне письмо? (Галузі, які цього потребують)

Ось чотири галузі, які найбільше потребують технічного письма.

Як стати технічним письменником 

Ось покрокова інструкція, як потрапити в цю сферу:

Крок # 1 - Вивчіть основи

Для початку вам не потрібно мати освіту в галузі комунікацій або знання англійської мови.

Ви можете розпочати і процвітати в цій кар'єрі, навіть якщо ви вчитель, журналіст, інженер або навіть хтось із медиків.

Пройдіть курси для початківців та отримайте сертифікати на Coursera, Udemyабо Курс технічного письма від Google. 

Слідкуйте за галузевими блогами, такими як  Напишіть документи і НТК (Товариство технічної комунікації).

Крок # 2 - Створіть портфоліо

Виберіть продукт, яким ви користуєтеся щодня (наприклад, кавоварку, додаток для фітнесу або розумну колонку), і напишіть посібник користувача або інструкцію з усунення несправностей. 

Це було б ідеально? Ні. 

Це дало б вам змогу показати щось конкретне? Безумовно. 

Спільнота з відкритим вихідним кодом, як GitHub відкрита для нових технічних авторів. 

Багато проектів відчайдушно потребують допомоги з документацією, і їм байдуже, що ви новачок. 

Крок # 3 - Отримайте роль початкового рівня

Зосередьтеся на позиціях з "junior" або "associate" в назві на таких платформах, як LinkedIn, Дійсно.і Ми працюємо віддалено. 

Не забувайте також про контрактні позиції - їх часто легше отримати, і вони можуть призвести до постійної роботи.

Крок # 4 - Розвивайте свою кар'єру

Після того, як ви набудете впевненості та досвіду, прагніть зайняти посаду старшого технічного письменника, API-розробника або UX-розробника.

Ознайомтеся з такими інструментами, як MadCap Flareі Кисень XML для структурованого письма або Уцінка і Git якщо хочеш працювати з розробниками. Але не обов'язково опановувати все й одразу.

Крок # 5 - Підготуйтеся до співбесіди

• Найпоширеніші питання включають:
  • Як спростити складну тему? → Покажіть приклад до і після написання.
  • Які інструменти ви використовували? Перерахуйте всі.
  • Як ви працюєте з відгуками від інженерів? → Наведіть реальний або гіпотетичний приклад. 

Крок # 6 - Продовжуйте вчитися та підвищуйте рівень

Сфера постійно розвивається. Одного року всі говорять про вікі, наступного - про документи як код. 

Люди, які процвітають, - це ті, хто продовжує вдосконалювати свої навички. 

Підпишіться TechWhirl і Вишневий листок за трендами.

Почніть вже сьогодні. Перепишіть інструкцію до продукту, поділіться нею на LinkedIn і попросіть про зворотній зв'язок.

Інструменти та програмне забезпечення для написання технічних текстів

Інструменти штучного інтелекту роблять ваші завдання простішими та ефективнішими - і технічне письмо не є винятком.

Ось технічні інструменти для написання текстів, якими користуються професіонали:

1. Для написання та редагування контенту:

1. MS Word дозволяє створювати професійно відформатовані документи з точним контролем стилів, заголовків і перехресних посилань. 
2. Google Docs дозволяє декільком членам команди одночасно працювати над одним документом. 

2. Для структурованої документації та публікацій: 

1. MadCap Flare дозволяє підтримувати єдине джерело контенту, яке автоматично публікується в різних форматах. 
2. Adobe FrameMaker обробляє вашу 500-сторінкову технічну специфікацію зі складними таблицями, спеціалізованими діаграмами та перехресними посиланнями. 

3. Для командної документації:

1. Злиття стає внутрішньою вікі вашої компанії, де різні відділи ведуть свою документацію. 
2. Поняття допомагає вашій продуктовій команді впорядковувати документацію паралельно з управлінням проєктами. 

4. Для управління та відстеження змін у документах:

1. GitHub дозволяє розробникам оновлювати документацію разом зі змінами коду.
2. BitBucket інтегрується з вашим конвеєром CI/CD, завдяки чому документація автоматично збирається та розгортається з кожним випуском.

5. Для досліджень, структуризації контенту та кращої читабельності:

1. Автор есеїв допоможе вам задокументувати складний алгоритм у відповідному контексті, з поясненнями та прикладами. 
2. SEO-райтер гарантує, що у вашій публічній документації використовується узгоджена термінологія та дотримано найкращих практик читабельності. 
3. Чат зі штучним інтелектом допомагає вашому технічному автору спростити складні поняття. Він пропонує альтернативні пояснення та визначає області, де користувачам може знадобитися додатковий контекст. 

Як штучний інтелект може підвищити ефективність написання технічних текстів

Ось як ШІ може допомогти вам у написанні технічних текстів: 

1. Автоматизація

Починати з чистого аркуша складно. Ви можете використовувати ШІ для створення початкового контенту на основі структурованих даних.

Це скорочує час, необхідний для створення інструкцій, посібників та звітів. 

Як це зробити...

Використовуйте такі інструменти штучного інтелекту, як Чат-бот зі штучним інтелектом щоб створити основні контури або навіть перший начерк.

Потім відшліфуйте мову, використовуючи галузеву термінологію, і перевірте контент на достовірність. 

2. Граматика та ясність

Використовуйте інструменти штучного інтелекту, щоб перевірити наявність жаргону, пасивного стану та проблем з читабельністю. 

Ось як ним користуватися...

Пропустіть чернетки через AI Paraphraser. Цей інструмент допомагає переписувати складні речення, пропонує альтернативні варіанти простої мови та покращує загальну читабельність.

3. Структурування контенту

Добре структурований документ запобігає плутанині.

ШІ може логічно організувати контент, групуючи пов'язані теми, додаючи заголовки та пропонуючи макети. 

Ось як ним користуватися...

Скористайтеся нашими AI Writer of Essay створювати звіти, інструкції та документацію.

Висновок

Технічні письменники перекладають "інженерну мову" на "людську".

Саме тому пілоти можуть безпечно саджати літаки, не читаючи 10 000-сторінкову інструкцію під час польоту, чому хірурги зосереджуються на порятунку життів, а не на розшифровці загадкових інструкцій, і чому ви можете користуватися цією модною кавоваркою, не створюючи випадкового гейзера на кухні. 

У нашому складному світі чітка комунікація має важливе значення.

Хороший технічний текст економить час, гроші, розчарування, а іноді й життя (в медичній сфері та сфері безпеки).

У майбутньому ми побачимо більше відео у вигляді інтерактивних посібників та документів, які адаптуються до вашого рівня знань. 

Якщо ви хочете розім'яти м'язи технічного письма, оберіть щось складне, що ви добре розумієте - наприклад, як працює фотосинтез, правило офсайду у футболі чи навіть як приготувати ідеальне суфле - і поясніть це другу у найпростіший і найзрозуміліший спосіб. 

Якщо вони розуміють, що замість того, щоб дивитись на нас остекленевшим поглядом, вітаємо!

Ви відкрили для себе основну навичку технічного письменника: робити складне простим.

Потрібна додаткова допомога? ШІ, який неможливо виявити інструменти вдосконалюють ваше письмо та роблять його бездоганним. Спробуйте їх зараз!

Не соромтеся вивчати наші Детектор штучного інтелекту та Humanizer у віджеті нижче!