Посібник із стилів для написання на Medium

Провівши більше 1000 годин, пишучи та редагуючи історії для нашої публікації Medium, я вирішив створити цей посібник для стилю життя для авторів. Не соромтеся використовувати його для публікації.

Заголовки

Це найважливіша частина вашої історії, і ви повинні подумати над ними серйозно.

Не використовуйте приманку:

"Ви не повірите цьому смішно ефективному заголовку темного візерунка"

Не використовуйте списки:

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

Скажіть правду:

«Розумний, але фактичний заголовок на цікаву тему»

Не позначайте історії, які є частиною 1 серії "частиною 1". Це відлякує людей, оскільки вони сприйматимуть читання як більший час. І хто знає, коли ти все одно напишеш частину 2.

Крім того, якщо ваш заголовок занадто довгий, Medium усіче його. Довгі заголовки також можуть запобігти появі вашого верхнього зображення у стрічках новин.

Зображення

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

Здебільшого ви хочете дотримуватися ширини стовпця:

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

І якщо ви справді пишаєтесь зображенням або якщо воно переповнене цікавими даними, перейдіть повним шляхом:

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

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

Так. Я все ще застряг тут.

Завжди включайте зображення із високою роздільною здатністю вгорі статті під вашим заголовком. Це має наступні переваги:

  1. Коли люди діляться вашою історією у Facebook та Twitter, вона буде більш помітною у стрічках новин, завдяки чому люди частіше натискатимуть на неї.
  2. Це буде виглядати краще у власних стрічках новин Medium.
  3. Люди є візуальними істотами, і натискають на зображення.

Атрибуція

Найпростіший спосіб атрибуції зображення - це поставити під зображенням слова “Кредит зображення” та пов’язати цей текст із першоджерелом.

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

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

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

"Коли у вас є власний розум, приємно зараховувати інших людей за їхні".

- Кріс Джамі

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

Код

Там, де це можливо, код повинен бути в текстовій формі, а не в зображеннях. Це робить код більш доступним для зчитувачів з екрану та простішим для копіювання та вставлення. Ось як це можна зробити:

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

Medium має прихований ярлик, який перетворить текст у звичайний текст ... medium.freecodecamp.com

Посилання

Придумайте спосіб опрацювання посилання у реченні. Якщо посилання є життєво важливим для історії, поставте його на власний рядок і натисніть клавішу Enter. Це створить попередній перегляд, наприклад:

Як стати на плечі велетнів

Conquer Not Invented Here Syndrome, то зробіть щось нове. medium.freecodecamp.com

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

Не вставляйте URL-адреси безпосередньо, наприклад: //www.example.com

Використовуйте їх домени верхнього рівня, якщо це частина їхнього бренду, наприклад art.com.

Вбудовування носіїв

Ви можете вставляти твіти, відео на YouTube та інші засоби масової інформації, вставляючи їх URL-адреси в Носій у новий рядок, а потім натискаючи клавішу Enter.

Використовуйте їх економно, оскільки вони можуть відволікти вашого читача від закінчення вашої історії.

Скорочення

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

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

"Давайте розберемо код на абстрактне дерево синтаксису (AST)."

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

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

Ось дуже короткий список технологічних скорочень, які вам не потрібно визначати: API, AJAX, BIOS, CPU, CSS, HTML, HTTPS, LAN, RAM, REST, USB, WWW, XML. Для всього іншого ви повинні написати це.

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

Форматування тексту

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

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

Якщо ви хочете щось підкреслити, використовуйте жирний шрифт . Курсив читати важче. Не виділяйте жирних гіперпосилань - рядок під ними вже надає достатньо уваги.

Використовуйте лише один знак оклику, як правило, тільки після вигуків типу: Golly gee! Хот-дог!

Розташуйте коми та крапки всередині лапок, за винятком випадків, коли це може заплутати читача (наприклад, з іменами змінних чи назвами книг).

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

Використовуйте англійську замість латиниці:

  • Використовуйте "наприклад" замість "EG"
  • Використовуйте "що є" замість "IE"
  • Використовуйте "зверніть увагу" замість "NB"
  • Замість того, щоб закінчувати списки "тощо" Почніть їх із "подобається": "Елвіс їв їжу, як хліб, арахісове масло і банани"

За даними Google Books, крапка з комою вмирає повільною смертю. Давайте виведемо їх із біди. Просто використовуйте замість крапки і розбивайте речення на окремі речення.

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

Стиль

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

  • пасивний стан
  • непотрібні прислівники
  • слова, що мають більш загальні еквіваленти

Додаток Хемінгуей присвоїть "рівень оцінки" для вашого письма. Навіть технічні історії можуть досягти рівня 6. І вони повинні прагнути.

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

Помилка на стороні розбиття довгих речень та абзаців на коротші.

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

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

Звертайтеся до свого читача як на "ви", а не на "ми" чи "ми". “Ми” не збираємося робити цей підручник, ваш читач збирається прочитати його і робити це самостійно.

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

Остаточна порада

Пам’ятайте, що коли ви публікуєте на Medium, ви просите тисячі людей подарувати вам кілька хвилин свого життя. Не сприймайте своїх читачів як належне.

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

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

Коли ви надсилаєте свою історію до публікації, ви повинні очікувати, що редактори дійсно її відредагують. Пам’ятайте, що ці люди витрачають набагато більше часу на редагування історій, ніж ви, і мають більш розвинене відчуття того, що працює. Але нехай це не заважає вам задавати запитання та виправляти фактичні неточності, які вони можуть внести.

Будьте обережні щодо публікацій, які публікують вашу історію, не вносячи жодних редагувань. Якщо вони не потрудились редагувати його (або навіть прочитати?), Вони, мабуть, також не докладуть особливих зусиль для його публікації.

О, і не відкривайте свою історію за допомогою “Це було опубліковано в моєму блозі за адресою” або “оновлення: це було опубліковано в Hacker News” Якщо ви вирішите додати подібні нотатки, поставте їх у самий кінець вашої історії. Люди не переходили до вашої історії лише для того, щоб їх негайно відправляли - вони прийшли читати вашу історію.

Зверніть увагу, що сам freeCodeCamp більше не публікується на Medium. Натомість ми публікуємо тут. Ось як опублікувати в публікації freeCodeCamp.

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