Глава 1 научит вас писать более понятную техническую документацию.
Содержание главы:
- Введение (3 мин) Вы сейчас тут
- Необходимый минимум грамматики (10 мин) (опционально)
- Слова (10 мин)
- Active voice (15 мин)
- Clear sentences (10 мин)
- Short sentences (20 мин)
- Lists and tables (15 мин)
- Paragraphs (10 мин)
- Audience (10 мин)
- Documents (10 мин)
- Punctuation (optional) (5 мин)
- Markdown (может варьироваться)
- Summary (1 мин)
Чтобы пройти этот курс, вам нужно уметь писать на русском языке и уметь, хотя бы на базовом уровне, писать и читать на английском.
Warning
От автора перевода: некоторые главы повествуют об особенностях применимых только к английскому языку.
Если вы никогда не проходили обучение technical writing, этот курс идеально вам подойдет. Если вы уже проходили обучение по technical writing, этот курс освежит вашу память и может повысить уровень квалификации.
Этот курс научит вас основам технического письма. После прохождения этого курса вы будете знать, как делать следующее:
- Последовательно использовать терминологию, включая сокращения и акронимы.
- Распознавать неоднозначные местоимения.
- Отличать активный залог от пассивного залога.
- Преобразовывать предложения с пассивным залогом в активный залог. Конечно, вот перевод оставшихся пунктов на русский язык:
- Определить три способа, по которым активный залог превосходит пассивный залог.
- Разработать как минимум три стратегии для создания более ясных и интересных предложений.
- Разработать как минимум четыре стратегии для сокращения предложений.
- Понимать разницу между маркированными и нумерованными списками.
- Создавать полезные списки.
- Создавать эффективные вводные предложения для абзацев.
- Сосредоточить каждый абзац на одной теме.
- Озвучить ключевые моменты в начале каждого документа.
- Определить целевую аудиторию.
- Определить, что ваша целевая аудитория уже знает, а что ей нужно узнать.
- Понимать "проклятье знаний".
- Опознать и пересмотреть идиомы.
- Описать цели (объем задач) и аудиторию вашего документа.
- Разделить длинные темы на соответствующие разделы.
- Правильно использовать запятые, скобки, двоеточия, тире и точки с запятой.
- Развить начальную компетентность в Markdown.
Для того чтобы стать отличным инженером или профи в technical writing, требуется многолетняя практика. Этот курс улучшит ваш навык, но не превратит вас сравзу в отличного писателя.
Данный курс состоит из двух компонентов:
- Теория
- Практика (очная)
Сейчас вы читаете начало теории.
Очные практические занятия усиливают ценность уроков рассказанных в теор. части. The in-class component enhances the lessons taught in the pre-class components. Тем не менее, теория сама по себе по-прежнему даёт ценный образовательный опыт.
Хоть этот курс и оптимизирован для ноутбука или ПК, вы так же можете пройти его на планшете или телефоне. Если вы проходите практическое задание, обратите внимание, что вам придется много печатать.
Для прохождения курса вам необходимо подключение к Интернету. Вы не можете скачать курс. Курс недоступен на материальных носителях.
Note
От автора перевода: данная версия курса может быть скачана из GitHub репозитория для оффлайн прочтения
Курс содержит несколько коротких видеороликов, просмотр которых не является обязательным. Если вы хотите пропустить видео, вы можете пройти курс при плохом или не стабильном подключении к интернету.
Мы отметили несколько глав как необязательные (опциональные). Тем не менее, они могут оказаться полезными для вас.
Продолжить чтение: Необходимый минимум грамматики (опционально)
Вернуться назад: Обзор курса