Оригінал статті знайдете за адресою http://www.cs.engr.uky.edu/~raphael/writing.html

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

Быть прямым и сильным.

Простота

Фраза «x может считаться y» лучше всего заменить на «x, как y». Конструкция «это x, которая задерживает y», должна быть записана как «x затухает y». В том же духе «мы называем x, когда frobbing y» должно быть «мы говорим, что x frobs y».

Укрепление

Абстрактные существительные и герундивы слабее, чем герундbи / причастия, которые в свою очередь слабее глаголов. Попытайтесь укрепить слабые конструкции. Например, «Джон увидел, что едят пиццу» следует писать так: «Джон видел, как они едят пиццу». «Ассоциация со свиньями ведет к грязи» должна быть «Если вы ляжете со свиньями, вы встанете грязно».

Слабые прилагательные и наречия

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

Слабые глаголы

Некоторые глаголы, особенно «make», «do», «is», «can» и «perform», часто используются в ситуациях, когда можно найти гораздо лучший глагол. Например, «Священник сделал чек после того, как кающийся сделал свое признание» лучше всего переделать, поскольку «священник проверил после того, как кающийся признался». Точно так же «я не могу сделать определение на основе одного симптома» должен быть написан как «Я не могу основать определение по одному симптому», или, что еще лучше, «я не могу определить его по одному симптому. » Если вы обнаружите, что большая часть вашего значения в ваших существительных, и очень мало в ваших глаголах, вы должны использовать более сильные глаголы. Симптомом является чрезмерное использование «есть» и «есть». Аналогично, если действие происходит, не говорите: «A может выполнять B»; вместо этого скажите «A выполняет B».

Двойные негативы

Удалите двойные негативы. Замените «не похожий на» на «аналогично». Замените «ничем не отличающийся от» с «похожим на» или «таким же, как». Иногда лучше заменить «не менее» на «больше или равно», хотя замена является более длинной.

Регистр

Не будьте слишком неформальными. Избегайте таких терминов, как «много» или «хороших». Вы должны быть более точными и более формальными.

Перебивание самого себя

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

Быть ясным.

Напряжение, настроение и голос

Время: используйте настоящее время, если нет необходимости использовать что-то еще. При необходимости вы можете использовать идеальное время: «другие показали». Не используйте простое прошлое: «другие показали».

Настроение: используйте индикативный вместо императива («x» или «мы видим x» вместо «обратите внимание, что x» или «напомнить, что x»), что заставляет читателя предпринимать определенные действия. «x» в большинстве случаев оказывается более сильным. Также избегайте «будет»; «есть», как правило, лучше.

Голос: постарайтесь избежать пассивного голоса. Активнее и понятнее.

Латинские аббревиатуры

Часто лучше использовать «например» и «то есть» вместо «например,». и «i. e.» , Аналогично, «и т. Д.» Лучше, чем «и т. Д.», ,

Техническая терминология

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

Это и

Мне полезно различать «то» и «что». Если подчиненное предложение помогает определить существительное, то есть важно и не может быть удалено, тогда уместно использовать «это» и не использовать никаких запятых для разделения предложения. Часто слово «это» служит прямым объектом подчиненного предложения. В этом случае слово «это» часто может быть отброшено. Если подчиненное предложение добавляет дополнительную информацию о не определяющем характере, то есть в скобках и может быть удалено, целесообразно использовать «which» и разделить подчиненное предложение запятыми.

Демонстративные прилагательные

Слова «это», «эти» и «то же самое» всегда требуют существительного. Пример: «Это приводит к тому же», может быть написано как «этот метод приводит к большой экономии». Точно так же «это», «это» и «они» всегда должны иметь ясный антецедент.

Выбор слова

Постарайтесь выбрать наиболее точное слово, которое охватывает ваш предмет. Например, «валлиец» более специфичен, чем «европейский», что более конкретно, чем «человек», что более конкретно, чем «млекопитающее».

Некоторые конкретные предложения:

Не путайте «законные» (в соответствии с законом) «действующие» (в соответствии с некоторыми ограничениями).
Не путайте «свою» (притяжательную форму «это») с «это» (сокращение для «это»).
Напишите «потому что» вместо «как», если вы показываете причинные отношения.
Не говорите «вопрос», когда вы имеете в виду «проблему» или «трудность».
Не говорите «как таковое», когда вы имеете в виду «поэтому» или «так».
Напишите «отличную от» или даже «отличную от» вместо «отличной от», что неприемлемо.
Не используйте «пока» или «тем временем», которые позиционируют события в строке времени, чтобы обозначать «но», «однако», «хотя» или «в то время».

Сравнения

Не говорите, что-то «лучше», «быстрее» или больше любым способом, если вы явно не укажете на то, что вы его сравниваете. Например, не говорите: «Синтаксис этого языка облегчает чтение».

Будьте грамматическими.

Цитирование

Цитаты следует рассматривать в скобках (хотя скобки могут быть квадратными скобками) и должны быть грамматически отделены от предложения.

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

Множественные

Некоторые слова, полученные на греческом и латинском языках, имеют нерегулярные множественные числа: критерий → критерии; средний → носитель; datum → data. Слово «данные» как единственное существительное получает признание. Другие множественные числа никогда не должны использоваться там, где требуется единственная форма.

Пунктуация

Знакам пунктуации никогда не предшествуют пробелы, кроме тире, которые, скорее всего, следует избегать и левую круглую скобку. Пунктуация всегда сопровождается одним пробелом, за исключением левой скобки, которая не имеет пробелов, период в конце предложения, который имеет два пробела, и двоеточие, которое иногда имеет два пробела. За колонами следуют два пробела и заглавная буква, если следующее — это положение; за ними следует одно пробел и строчная буква в противном случае. Предложение — это предложение или фрагмент, который имеет как субъект, так и глагол. Независимые предложения в одном и том же предложении разделяются точкой с запятой. (Пример: «Я пришел в себя, рассвет поднялся»). Зависимые предложения (те, которые вводятся союзами, например «с», «и» или «но») вводятся запятыми. Не разделяйте тему и глагол оговорки запятой. Если цитируемый текст должен заканчиваться пунктуацией, поместите пунктуацию внутри кавычек, если цитируемый текст не является техническим термином, и пунктуация не должна приниматься как часть этого термина. Не помещайте никаких знаков препинания в конце раздела, если заголовок не составляет всего предложения.

Двухсловные прилагательные

Для двухсловных прилагательных требуется дефис между двумя словами. Наречие, за которым следует прилагательное, не обязательно иметь дефис (но быть последовательным). Никогда не помещайте дефис между прилагательным и его существительным.

Статьи около аббревиатур

Если понятие сокращено, например, AC для «сокращенной концепции», тогда, когда AC используется как существительное, он не требует статьи, но когда он используется в качестве прилагательного, ему требуется статья, если вам понадобится без AC , Например, «AC» не требует статьи, но «метод AC» требует статьи. Заголовок, такой как «структура переменного тока», не требует статьи. Это правило естественно для носителей английского языка, но очень сложно для некоторых других.

Другие подсказки

Дорожные карты

Вам не нужно говорить, что в Разделе 1 есть x, в Разделе 2 показаны y и т. Д. Читатель может обратиться к оглавлению.

С точки зрения

Фраза «в терминах x» должна использоваться только в том случае, если x — это область дискурса, которая имеет термины (то есть специальный словарь), и если следующее обсуждение фактически использует эти термины. Я предпочитаю вообще избегать этой фразы.

И т.п.

Списки не должны заканчиваться словами «и т. Д.», , Большинство списков начинаются с «например», поэтому нет смысла указывать, что существует больше примеров.

Глагольные существительные

Некоторые существительные могут использоваться в качестве глаголов, например, «чтобы изобразить сцену». Однако внесение существительных в глаголы может привести к отвратительным варварствам. Например, «у нас больше нет места для офисных людей», «его присутствие сильно влияет на нас» и «на диалог с кем-то». То же самое относится к прилагательным, используемым как существительные, а в более общем случае — к словам, которые используются ненадлежащим образом. Такое злоупотребление характерно для преднамеренной неясности бюрократического жаргона.

Гендерные местоимения

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

Метапотамия (изменение лошадей в середине потока)

Старайтесь не нарушать параллельные структуры, отклоняясь от синтаксического параллелизма. Например, не пишите: «Кажется хорошим, это звучит хорошо, и его внешний вид довольно хорош». Точно так же не переключайтесь между активным и пассивным, когда можете сделать две половины мышления. Например, не говорите: «Покрасочные дома их сохраняют, а дома также украшены кустарниками». Вместо этого скажите: «Живопись домов сохраняет их, а кустарник их украшает».

Паратетические замечания

Старайтесь избегать вложений в скобки. Если их стоит делать, они, скорее всего, стоят в регулярных предложениях.

Рекомендации

Каждый, кто интересуется четким письмом, должен прочитать классическое сочинение Джорджа Оруэлла «Политика и английский язык». В конце этой 10-страничной работы Оруэлл перечисляет несколько правил. Среди них есть советы, что англосаксонские слова часто сильнее, чем латинские слова, и что нужно нарушать любое правило, прежде чем писать что-то прямое варварское. Хорошим руководством к английскому стилю является книга Фаулера «Современное английское использование». Это часто довольно интересно. Книга Струнда и Уайта «Элементы стиля» недорогая и хорошая. Словарь американского наследия обсуждает использование английского языка и согласуется с моим уклоном относительно «этого» и «о том, что / что». Книга Линн Траус «Ешь, стреляет и оставляет» — очень интересная ссылка на пунктуацию. Вы могли бы также взглянуть на написание предложений из Университета Северной Каролины.

Written by