Мой опыт участия в учебном лагере Empower Her X Non-Tech In Tech Bootcamp

Это документация о моем общем прогрессе в обучении в буткемпе, организованном сообществом Empower her и Non-Tech In Tech.

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

Первая неделя: Введение в техническое письмо

В течение первой недели нас обучали основам технического письма.
Наши наставники, Бенни Ифеаний Ихеагвара и Блессинг Эне Аньебе, представились, рассказали о своих должностных обязанностях и опыте работы в качестве технических писателей и пообщались с нами в начале первого занятия, расспросив некоторых из нас о наших нынешних профессиях и знаниях в области технического письма.

Занятия первой недели были насыщенными, наполненными ресурсами для начинающих и руководствами для новичков. Я описал первую неделю своего обучения в этом блоге.

Нашей первой задачей на неделю было создание блога и размещение ссылок, приоритетом которых был технический контент, таких как Hashnode, dev.to, Medium и Hackernoon. Тех, у кого были уже существующие аккаунты блогов на публикациях, мы попросили прислать ссылки в предоставленную таблицу Google Docs.

Вторая неделя: Инструменты в техническом письме

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

Инструменты, которые нам было поручено постичь, были разделены на следующие;

  • Инструменты для исследований
  • инструменты для ведения заметок
  • инструменты создания текстов
  • Медиа-инструменты
  • Инструменты редактирования
  • Инструменты публикации
  • Инструменты документирования
  • Инструменты для совместной работы и управления

Интересной концепцией, которая была предложена, является Docs-as-Code: подход, который заставляет технических писателей применять свои знания по разработке программного обеспечения в документации.
Его можно использовать с помощью следующих средств:

  • Контроль версий с помощью Git
  • Автоматизированное тестирование, сборка и доставка
  • отслеживание проблем, и
  • Использование разметки обычного текста, популярным примером которой является Markdown, используется для редактирования наших статей и придания им читабельности для аудитории.

Заданием на эту неделю было написать статью на любую тему по нашему выбору и отправить ее в Google Docs по ссылке в электронной таблице, предоставленной для отправки.

Третья неделя: Обзоры статей

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

  • Использование конспекта во время написания статьи
  • Необходимое использование инструментов для написания и редактирования статей, таких как Grammarly, Hemmingway Editor и Markdown, для редактирования статей и обеспечения их читабельности.
  • Выбор привлекающей внимание темы и написание интересного введения и заключения.
  • Использовать фотографии, имеющие отношение к статье, отдавая должное их владельцам и ссылаясь на использованные источники.
  • Избегать плагиата, включая ранее написанные работы.

В конце обзора нам было предложено опубликовать первые статьи в своих блогах.

Неделя 4: SEO-оптимизация в техническом письме

SEO-оптимизация — это просто сделать вашу статью более доступной для поисковых систем.
Нас учили, как структурировать наши статьи, чтобы привлечь целевую аудиторию, исправляя следующее:

  • Избегать плагиата.
  • Кросспостинг в различных блогах или публикациях с использованием канонических ссылок.
  • Давать статьям хорошо структурированные заголовки.
  • Уместное использование заголовков.
  • Использование правильных ключевых слов, внутренних и внешних ссылок.
  • Обеспечение доступности и отзывчивости на разных устройствах. В конце урока этой недели мы получили задание написать вторую статью и опубликовать ее в своих блогах.

Неделя пятая

Часть 1: Документация API

Пятая неделя обучения началась с другой игры: API Documentation.

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

Это занятие проводил Лайт Сегун, который проделал прекрасную работу, объясняя концепции простыми словами.

Часть 2: Вклад в работу с открытым исходным кодом в качестве технического писателя

Это распространенное заблуждение, что только программисты могут вносить вклад в проекты с открытым исходным кодом, поэтому это занятие было хорошо воспринято, так как оно рассказывало о тонкостях технического письма и его месте в сообществе open-source.
Мы узнали об основах вклада в open-source, проектах, в которые можно вносить вклад, бесплатных и платных программах open-source, а также о том, как создавать портфолио технического писателя, используя свой вклад.

Дополнительные уроки мы получили по следующим темам:

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

Шестая неделя: Заключение

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

Траектория моего обучения

В начале обучения в буткемпе я имел ограниченное представление о том, что ожидается от технического писателя.

Однако уроки и задания вдохновили меня двигаться дальше и пробовать новое.
Ниже перечислены мои достижения:

  • Я опубликовал свою первую статью на сайте dev.to
  • Я научился делиться своими успехами на платформах социальных сетей, особенно в Twitter.
  • Мой первый подробный учебник и вторая статья были опубликованы на Dev Community.
  • Я начал свой путь к открытому исходному коду, став автором на FreeCodeCamp.

Ресурсы

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

Подведение итогов

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

Оцените статью
devanswers.ru
Добавить комментарий