Багато людей вважають, що, щоб бути хорошим технічним письменником, ви повинні бути експертом з тематики. І хоча це поширена помилка, це не дивно, що люди підтримують цю віру. Адже ваша робота як технічного письменника полягає в тому, щоб повідомляти складну, технічну інформацію аудиторії таким чином, який легко перетравлювати. На щастя, реальність полягає в тому, що вам не потрібно бути МСП, щоб написати технічну статтю світового класу. Необхідність - це цікавість, структура і готовність задавати експерту з предметів правильні питання.І в цьому краса технічного написання: задавати правильні питання важливіше, ніж мати всі відповіді. до Керівництво не-SME до великої технічної історії Брендируйте свою відсутність досвіду, як зброю, якою вона є Це відсутність досвіду, про який ви так турбуєтеся, дає вам цікаву перевагу - можливість підходити до предмету з тим же самим та Ви задаєте питання, які фахівці забувають поставити (ті, які ваші читачі також мовчазно запитують), запитуєте кожну концепцію, розбиваючи жаргон на просту мову, і заповнюючи власну прогалину у знаннях, дайте читачеві найкращий досвід. greenness curiosity https://ucatt.arizona.edu/news/curse-knowledge?embedable=true Створення відносин з експертом з предметів Ми встановили, що вам не потрібно бути МСП, щоб написати велику технічну історію, але І вам потрібно побудувати відносини з цією людиною (або ресурсом). вам потрібен зв'язок з мозками за технічним проектом / предметом, про який ви пишете. someone Ваше завдання - бути мостом між уявленнями цієї людини та вашими читачами. Але ось що стосується МСП: вони часто живуть глибоко всередині складності своїх власних систем. Ви там, щоб витягнути ці уявлення і перекласти їх у щось, що подорожує. Повірте, що ви будете точно представляти їхню роботу, задавати продумані питання і поводитися з їхнім часом з повагою. build trust. Як спілкуватися з МСП Зробіть свої домашні завдання спочатку.Не показуйтеся на засідання МСП порожнім.Читайте, досліджуйте і готуйтеся з конкретними, розумними питаннями. Запитайте «чому» більше, ніж «що». «що» розповідає вам, що було побудовано; «чому» розповідає вам, для кого це і чому це важливо. Поясніть термінологію негайно. Не обманюйте розуміння. Неправильно використані терміни в технічній частині можуть зіпсувати вірогідність. Надішліть коротке відстеження з тим, що ви зрозуміли, і переконайтеся, що ви на тій же сторінці. Перекладати, не перекладати Коли ви готові поставити ручку на папір, ви повинні пам'ятати, що ваша робота не полягає в тому, щоб викинути жаргон експерта на сторінку. На практиці це означає зняття жаргону до простої мови. читач буде зачіпаний продуктом / послугою, а не всіма цікавими технологіями, які його забезпечують. Як Але замість того, щоб говорити, Скажіть мені, "Продукт XYZ чудовий, тому що він побудований з найсучаснішим, першим у своєму роді бла бла", - сказав він. "Продукт XYZ, побудований з найсучаснішим blah blah, чудовий, тому що він допомагає вам робити ABC". Перший ряд збагачує технологію, другий - читачеві. В кінці дня ви будуєте міст між експертними знаннями та повсякденним розумінням.Чим ясніше міст, тим більше людей зможуть його перетнути. Факт-перевірка, як від нього залежить ваше життя Це не є обов'язковим, особливо для не-МСП. Технічні історії залежать від точності. На відміну від прози, ваші факти повинні бути 100% вірними та перевірятися, ваш код MUST працювати, а ваші приклади MUST бути відтворюваними. Запускайте все - скріншоти, фрагменти коду та статистику - назад до вашого експерта для підтвердження. Ви граєте в гру довіри, і ніщо не ерозує його швидше, ніж помилка, яка могла бути захоплена одним електронним листом. Сказати історію (Keyword, “Story”) Як тільки ви перевірите факти, побудуйте історію. В кінцевому підсумку, технічна література залишається . Писати І це означає, що вона потребує структури, потоку і виплати. (проблема або мета), розгорнути (своїм процесом або відкриттям), і наблизитися до (Відкриття або дії why how what next Щоб зробити все простіше, ми побудували практичне керівництво, засноване на цій точній 3-актовій структурі. Починайте з нього тут: Технічний шаблон для написання розповідей. Get started with it here: . Technical Storytelling Writing Template Технічний шаблон для написання Пишіть, ніби ви пояснюєте це друзям, і якщо ви коли-небудь забуваєте, з чого почати, пам'ятайте, що ясність перемагає складність кожен раз. Ми сподіваємося, що це запропонувало вам деяку ясність (і заспокоїло ваші побоювання) щодо навігації в галузі технічного письма без предметного досвіду. До наступного разу!
