Организаторы Techwriter Days выложили в открытый доступ видео выступления Кати Горбуновой и Насти Московкиной, двух авторов нашего канала.
Делимся и с вами!
https://vkvideo.ru/video-223804668_456239155

Настало время для елки техписа!
🎄🎄🎄

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

Каждый украшает свою елку по-своему. Кто-то каждый год покупает новый комплект игрушек в одном цвете, кто достает с антресоли коробку со старыми советскими игрушками, кто-то украшает конфетами и мандаринами…

А давайте нашу новогоднюю елку украсим пожеланиями нашему сообществу на новый год?

После новогодних праздников всем пожеланиям присвоим номерки и с помощью рандомайзера разыграем небольшой сувенир от «Давайте перепишем!»

Начнем: Мы желаем всем нам амбициозных и интересных задач в новом году!

Кружка техписа и воспоминания о Новом годе

Как обещали, подводим итоги нашего новогоднего розыгрыша!

Беспристрастный рандомайзер выбрал победителя, номер 16 (смотрите видео в комментариях).

И это оказалась @Katushka_13. Екатерина, поздравляем!

Поздравляем! Дарим вам вот такую кружку техписа :)

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

Канцеляризм: найти и уничтожить

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

“Является”

Устройство Гамма является основным компонентом системы управления.

Как переписать: чаще всего можно заменить на тире.

Устройство Гамма — основной компонент системы управления.

“Требуется”

Чтобы получить доступ к новым функциям, требуется обновить систему.

Как переписать: лучше всего заменить на повелительное наклонение.

Чтобы получить доступ к новым функциям, обновите систему.

“Данный”

В данном разделе вы можете управлять заявками.

Как переписать: обычно можно просто пропустить.

В разделе вы можете управлять заявками.

“В настоящий момент”

В настоящий момент создание новых карточек товаров недоступно.

Как переписать: пропустить или заменить на “временно” или конкретный срок, если нужно это подчеркнуть.

Создание новых карточек временно недоступно.

“В целях”

В целях безопасности пароль не отображается.

Как переписать: заменить на “для”.

Для безопасности пароль не отображается.

“Соответствующий”

Загружайте обновления ПО в соответствующем порядке.

Как переписать: можно просто пропустить и указать, что именно имеется в виду.

Загружайте обновления ПО в порядке, который пришлет администратор сети.

“В противном случае”

Если вы хотите отслеживать заказ, авторизуйтесь. В противном случае нажмите Заказ в один клик.

Как иначе: заменить на “иначе”.

Если вы хотите отслеживать заказ, авторизуйтесь. Иначе нажмите Заказ в один клик.

Замена не идеальна, как лучше формулировать в таких случаях расскажем в одном из следующих постов.

А что бы вы еще добавили в список? Какие у техписов самые частые слова-паразиты? Давайте исповедуемся в комментах про свои 😉

#давайте_практику

Инструкция к техническому писателю. Как быстро «подружить» техписа с командой заказчика

Устали объяснять, чем вы занимаетесь и почему вас нужно звать в проект раньше, чем «вчера»? Евгения Береснева, один из авторов нашего канала, на TechWriter Days 2 рассказала про инструмент, который помогает решать эти проблемы. Организаторы опубликовали видео доклада — делимся им с вами.

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

Смотреть видео: https://vkvideo.ru/video-223804668_456239176

Документация API: пишем первое описание метода

Эндпоинты, коды, JSON, Swagger, Postman — новичку бывает страшно даже заглянуть в документацию API. С чего начать и как не потеряться в деталях — разбираемся вместе.

Работа над документацией API начинается с понимания, для чего существует API, какие задачи решает и для кого. Документацию API обычно пишут для разработчиков, поэтому каждое описание должно чётко и максимально кратко объяснять, зачем нужен метод, как сделать запрос, что будет в ответе.

Начните с описания самого простого метода, обычно это получение данных.

В описании укажите:
• URL ресурса, куда отправляем запрос

https://api.market.com/v1/users/{id}

• HTTP-метод — действие, которое выполняет метод

GET

• Название метода

Получить имя пользователя

• Что делает метод

Метод возвращает имя пользователя по его ID

• Параметры запроса и как их передать. Для каждого параметра добавьте имя, краткое описание, тип данных, обязательность. В нашем примере параметр передаём в пути (path)

Параметр: id
Где передаётся: path
Тип: integer
Обязательность: true
Описание: ID пользователя

• Коды ответов с расшифровкой их значений — что вернёт метод

200 OK — Успех
404 Not found — Пользователь не найден

• Поля ответа — что получим в ответе. Также с краткими описаниями, типом данных, обязательностью

Поле: name
Описание: Имя пользователя
Тип: string
Обязательность: true

• Пример успешного запроса

https://api.market.com/v1/users/15437

• Примеры разных ответов
200

{ "name": "Иван" }

404

{ "error": "Пользователь не найден" }

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

#давайте_практику

С Днем технического писателя, коллеги! 🎉🎉🎉

Желаем вам поменьше завалов! :-)

#давайте_мем

Давайте розыгрыш!

Уже совсем скоро нас ждёт классная конференция WriteConf, где соберутся все, кто работает с текстами в IT. Это технические писатели, UX-редакторы, контент-менеджеры, локализаторы и много кто еще.

26 февраля в Москве (и онлайн).

Мы были на прошлой WriteConf всей нашей редакцией и нам очень понравилось. В этот раз тоже шикарные доклады, нетворкинг и даже прожарка текстов в прямом эфире и нытинг-сессия 😱 😁

По уже сложившейся традиции разыгрываем билет на конференцию 🎉
Билет офлайн — то есть посещение всех докладов, доступ к записям, нетворкинг и afterparty.

Условия простые:
— Быть подписанным на наш канал и канал конференции.
— Написать в комментах в свободной форме о вашем желании участвовать.

Через неделю присвоим всем номерки и запустим рандомайзер.

Делитесь постом с коллегами, чтобы и им дать шанс (ну или не делитесь, чтобы оставить все шансы себе 😁).

#давайте_анонс

Тестовое онлайн. Чего ждать?

Уже не раз в профессиональных чатах, да и мы на канале, обсуждали тестовые задания и портфолио. А тем временем всё больше работодателей стали давать тестовые задания прямо на собеседовании. Постараемся рассказать об основных видах заданий на собеседованиях, которые были в нашей практике.

Вычитка
Мы встречали разные варианты: от «вычитать 3 абзаца» до «154 страницы за 40 минут». Ожидания от этих двух заданий абсолютно разные.

Разработка структуры документа
На таких заданиях просят накидать основу для структуры какого-то известного b2c сервиса.

Работа с GIT
Тут тоже были вариации на тему: от «решить простенький конфликт» до конкретных задач. Например таких: реши проблему «При git pull или git fetch: «error: cannot lock ref 'refs/remotes/origin/{branch}': is at {commit-sha1} but expected {commit-sha1}»».

Логические задачки
Да-да, они до сих пор актуальны. Про лампочки, ведра и т.д.

Задание на английском
Как-то раз было задание прочитать текст на английском и по нему ответить на вопросы на русском языке.

А вы встречали на собеседованиях практические задания в прямом эфире? Если да, то какие?

#давайте_про_профессию

Кому повезло в розыгрыше?

Пятница 13-е оказалась счастливым днём для @nanoanna 🎉🎉🎉

Скоро свяжемся и расскажем, как получить ваш билетик :)

Для всех остальных наших подписчиков тащим промокод на скидку 10%. Введите при покупке ДавайтеСкидку.

Увидимся 26-го ;-)

#давайте_анонс

Узнать свою ЦА

Чем лучше мы понимаем наших читателей, тем лучше они будут понимать наши тексты.

И вот что стоит выяснить в первую очередь:

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

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

🖌 Контекст работы с документацией. Инструкция всегда открыта в соседней вкладке браузера или лежит на рабочем столе в печатном виде? Открывается только при возникновении проблем или в начале работы? Читают с телефона или с компьютера?

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

#давайте_про_процессы

Навстречу завтрашней конференции 😁
#давайте_мем