Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mnik01/technical-writing

Перевод Google гайдов по technical writing на русский язык
https://github.com/mnik01/technical-writing

course google russian russian-language technical-writer technical-writing translation

Last synced: 22 days ago
JSON representation

Перевод Google гайдов по technical writing на русский язык

Awesome Lists containing this project

README

        

# Technical writing | Адаптация курса на русский
> Оригинал - https://developers.google.com/tech-writing/overview

> Прогресс перевода ![](https://geps.dev/progress/9)

## Обзор курса technical writing
Данная таблица представляет главы курса по technical writing:

| Название | Описание | Теория | Практика |
| -------- | -------- | ------ | -------- |
| [Глава 1](./chapter-one/intro.md) | Изучение основ technical writing. Пройдите этот курс перед тем как приступать к другим. | 2 часа | от 2 до 2.5 часов |
| [Глава 2](./chapter-two/intro.md) | Практика в четырех продвинутых темах по technical writing. | 1 час | от 2 до 2.5 часов |
| [Доступность](./a11y.md) | Развитие навыка, позволяющего сделать документацию более доступной для всех. | - | 1.5 часа |
| [Обработка ошибок](./error-handling.md) | Научит писать более четкие и эффективные сообщения об ошибках, независимо от того, для IDE они, командной строки или графического интерфейса. Этот курс доступен только онлайн. | 1.5 часа | - |

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

Google предоставляет все материалы, необходимые для проведения очных занятий в вашей организации. Если вы хотите провести аудиторные занятия для своей организации, см. раздел [«Содействие курсам по technical writing»](https://developers.google.com/tech-writing/for-instructors).

> [!NOTE]
> Note: Google иногда проводит бесплатные очные занятия, открытые для широкой публики. Подробнее в [анонсах](https://developers.google.com/tech-writing/announcements).

При написании _Technical Writing Глава 1_ и _Technical Writing Глава 2_ мы целились в аудиторию:
- Инженеры-программисты
- Инженеры-программисты или студенты изучающие IT

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

При написании _Tech Writing Доступность_ мы целились в аудиторию, которая пишет тех. документы или создает сайты с документацией, включая:
- Инженеры
- Мэнэджеры
- Продукт мэнэджеры
- Авторы документаций

**Продолжить чтение:** [Глава 1: Введение](./chapter-one/intro.md)

---
Дополнительные ресурсы для изучения:
- https://techwriters.ru/ru/learning.html