СОВЕТЫ, КАК СТАТЬ ХОРОШИМ ТЕХНИЧЕСКИМ ПИСАТЕЛЕМ.

СОВЕТЫ, КАК СТАТЬ ХОРОШИМ ТЕХНИЧЕСКИМ ПИСАТЕЛЕМ.

Введение

Использование курсива и жирного шрифта.

Заголовки.

Ссылки

Изображений.

Цитата.

Списки.

Пункты

Заключение.

Введение

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

Что важно в техническом письме, так это то, как информация представлена ​​аудитории, потому что всякий раз, когда аудитория читает статью, написанную техническим писателем, он / она ожидает прямой документации с хорошим расположением формулировок, которая включает в себя хороший заголовок, абзацы , ссылки и использование курсива, когда это необходимо. Это критерии, которые составляют хорошую статью.

Использование курсива и жирного шрифта.

Курсивные буквы — это буквы, которые наклонены вправо, и текст становится светлее, чем другие. Курсив часто используется для выделения определенного слова или предложения, в то время как полужирный шрифт — это набор символов, которые темнее и тяжелее, чем обычные буквы.

Мы будем изучать два основных текстовых формата, которые были определены выше, но мы будем использовать их постепенно для правильного понимания.

Курсив

Чтобы выделить фразу курсивом, вы можете окружить слова знаком подчеркивания (_). Например, _Лоуренс красивый_ и станет Лоуренс красивый_; вы можете написать несколько предложений курсивом, и вам нужно только поставить подчеркивание в начале предложения и в конце предложения.

Жирный шрифт

Точно так же, чтобы сделать фразы жирными, вы можете окружить слова двумя звездочками (**). Это сделает определенные слова жирными, например,

**Вы хотите сказать, что Лоуренс — технический писатель?**. Здесь все предложение будет выделено жирным шрифтом, как в Вы говорите, что Лоуренс — технический писатель?

Примечание. Вы можете одновременно писать слова или предложения жирным шрифтом и курсивом, комбинируя звездочки и знаки подчеркивания. Например:

• *_Вы считаете Лоуренса лучшим?_**

Вывод: Вы считаете, что Лоуренс лучший?

Заголовки.

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

Чтобы сделать заголовок на странице, вы используете решетку (#). # здесь показывает плотность заголовка, поэтому, чем больше #, тем менее плотными будут слова или заголовок. И for может иметь от 1 до 6 хэшей. он показывает толщину заголовка в порядке убывания.

#Это Лоуренс

Результат: Это Лоуренс.

##Это Лоуренс 2

вывод: Это Лоуренс 2

###Это Лоуренс 3

Результат: Это Лоуренс 3.

####Это Лоуренс 4

вывод: Это Лоуренс 4

#####Это Лоуренс 5

вывод: это Лоуренс 5

Это последний заголовок

Это последний заголовок.

Порядок расположения зависит от того, для чего используется статья, но не более 6 хэшей.

Ссылки

Ссылки можно определить как шлюз, ведущий с одной веб-страницы на другую. В начале этой статьи вы увидите подчеркнутое слово (Бесплатный словарь). Бесплатный словарь — это слово, в которое встроена ссылка, всякий раз, когда вы нажимаете на ссылку, она перенаправляет вас на указанную страницу.

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

встроенные ссылки:

Чтобы создать встроенную ссылку, вы заключаете текст ссылки в квадратные скобки ([]) и заключаете ссылку в круглые скобки ( () ). Например, давайте создадим случайную ссылку на GitHub-аккаунт Лоуренса [Lawrence’s GitHub] (https://github.com/Lawrencmagnat). На выходе будет GitHub Лоуренса

Примечание: Вы можете создать ссылку в шапке, хотя это неудобно, но это все же можно сделать.

Справочные ссылки:

Как следует из названия, ссылка на самом деле является ссылкой на другое место в документе. Хотя она выполняет ту же работу, что и встроенная ссылка, но ее можно вызывать несколько раз в документах или использовать для перехода с одной страницы на другую.

Например, создадим ссылку на одну из статей Лоуренса [статья Лоуренса](https://link.medium.com/ns0S7BAy9wb). На выходе будет Статья Лоуренса.

подсказка: может быть две скобки, например

[посетить Google]: www.google.com

[посетить Facebook]: www.facebook.com

Изображений.

Поскольку мы научились создавать ссылки в нашем документе, мы также должны знать, как создать изображение на нашем веб-сайте. Для создания изображения используется такой же синтаксис, как и при создании ссылки. Разница между ссылками и изображениями заключается в том, что перед изображениями ставится восклицательный знак (!).

Изображения имеют два стиля, это называется встроенным и ссылкой на изображение.

Встроенная ссылка на изображение

Чтобы создать встроенную ссылку на изображение, введите восклицательный знак (!), и заключите замещающий текст в квадратную скобку ( [ ] ). (Альтернативный текст — это фраза или предложение, описывающее изображение для слабовидящих.)

Например, чтобы создать встроенное изображение, например https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQdSCer89eMKgubQyyHJZzxxB76H_ObUzBMMQ&usqp=CAU, с alt, который говорит «Лоуренс, это ссылка; это можно сделать:

.

Выход:

Ссылка на справочное изображение:

Для ссылок на справочные изображения вы будете следовать тому же шаблону, что и справочные ссылки, но должны иметь восклицательный знак. Например:


Выход:


выход:

Цитата.

Цитата используется, чтобы привлечь особое внимание к цитате из другого источника или дизайну из другой статьи. Цитата — это предложение или абзац, специально отформатированный для привлечения внимания читателя. Например:

Ленивость — самая опасная чума, которая может случиться с молодым человеком в 21 веке.

Как создать цитату:

Чтобы создать цитату, все, что вам нужно сделать, это поставить перед строкой знак вставки «больше чем» ( › ). Например:

› «Некоторые рождаются великими, некоторые достигают величия, а некоторым величие навязано им. Вина, милый Брут, не в наших звездах, а в нас самих. Я терял время, и теперь время тратит меня. Позволь мне обнять тебя, кислая невзгода, ибо мудрецы говорят, что это самый мудрый путь».

результат:

Некоторые рождаются великими, некоторые достигают величия, а некоторым величие навязывается. Вина, милый Брут, не в наших звездах, а в нас самих. Я терял время, и теперь время тратит меня. Позволь мне обнять тебя, кислая невзгода, ибо мудрецы говорят, что это самый мудрый путь. Уильям Шекспир

Вы можете поставить курсор на каждую строку цитаты. Это полезно, если ваша цитата состоит из нескольких абзацев. Например:

› «Если музыка будет пищей любви, продолжай играть,
Дай мне ее в избытке; что переедание,
Аппетит может заболеть и, таким образом, умереть ».
›―Уильям Шекспир.

вывод:

«Если музыка будет пищей любви, продолжай играть,
Дай мне ее в избытке; что переедание,
Аппетит может заболеть и, таким образом, умереть ».
Уильям Шекспир.

› «Мне так хотелось лечь рядом с ней на диван, обнять ее руками и уснуть. Не блять, как в тех фильмах. Даже не заниматься сексом. Просто спите вместе в самом невинном смысле этого слова. Но мне не хватило смелости, и у нее был парень, и я был неуклюжим, и она была великолепной, и я был безнадежно скучным, и она была бесконечно очаровательна. Поэтому я вернулся в свою комнату и рухнул на нижнюю койку, думая, что если люди — это дождь, то я — изморось, а она — ураган».

›―Уильям Шекспир.

вывод:

«Мне так хотелось лечь рядом с ней на диван, обнять ее руками и уснуть. Не блять, как в тех фильмах. Даже не заниматься сексом. Просто спите вместе в самом невинном смысле этого слова. Но мне не хватило смелости, и у нее был парень, и я был неуклюжим, и она была великолепной, и я был безнадежно скучным, и она была бесконечно очаровательна. Поэтому я вернулся в свою комнату и рухнул на нижнюю койку, думая, что если люди — это дождь, то я — изморось, а она — ураган».

Уильям Шекспир.

N/B: Цитата может содержать другие элементы письма, такие как курсив, полужирный шрифт, изображения и ссылки.

Списки:

Список используется для оформления. Существует два основных типа списка

1. Ненумерованный список
2. Упорядоченный список

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

Чтобы создать неупорядоченный список, вы должны поставить перед каждым из них одну звездочку (*). Каждый элемент списка также получает свою строку. Например, список продуктов может выглядеть так:

*Молоко

*Хлеб

*Шоколад

*Мед

Вывод:

• Молоко
• Хлеб
• Шоколад
• Мед

Упорядоченный список:

Упорядоченный список начинается с цифр вместо звездочек (*). Например:

Лоуренс написал 6 статей, а именно:

1. Гит и Гитхаб.

2. JavaScript

3. ЧатGPT ИИ

4. Draw-io или Lucidchart

5. Асинхронный JavaScript

6. Введение в технологию.

Результат будет таким же, как и ввод, поэтому он называется упорядоченным списком.

Подсказка: вы можете написать подсписок, используя упорядоченный или неупорядоченный список; вы даже можете комбинировать оба стиля списка, используя упорядоченный список в качестве основного списка и стиль неупорядоченного списка в качестве подсписка.

Пункты

Согласно The Britannica Dictionary, абзац — это часть текста, которая обычно касается одной темы, начинается с новой строки и состоит из одного или нескольких предложений. Хороший абзац должен иметь полное тематическое завершение в соответствии с основной идеей, обсуждаемой в статье.

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

Некоторые писатели всегда склонны к ошибкам всякий раз, когда вызывается разбиение на абзацы, они продолжают разбивать на новые строки, оставляя первоначальную идею незавершенной. Идея абзаца должна быть завершена до вступления в новый абзац. Длина абзаца не имеет значения, важны идеи для демонстрации. Абзац может быть длинным, но бесполезным, а краткий, но мощный – наоборот. Абзацы выражают чувства, понимание и знание авторов по отношению к определенному исследованию.

В абзаце не должно быть слишком много резких разрывов, а должно быть несколько жестких разрывов, в основном это мягкие разрывы. Вы можете спросить, что такое жесткие и мягкие перерывы. Разрыв — это процесс добавления нескольких точек (многоточие) в предложение.

Например, Королева — подруга Лоуренса…….

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

Заключение.

Техническое письмо, как я уже говорил ранее, нуждается в точности, без точности это будет просто мусор. Хотя человек не может проснуться и стать хорошим писателем «НИКОГДА», стать хорошим писателем можно, практикуясь каждый день. Со знанием того, чему вы научились, продолжайте практиковаться, пока не станете сильнее, чем ожидали.

N/B: Техническое письмо относится к любому письму, имеющему отношение к специализированной области, обычно в области науки или промышленности. Поскольку техническое письмо обычно имеет дело с объектом, процессом или абстрактной идеей, язык является утилитарным, подчеркивающим точность, а не стиль.