Давайте перепишем!

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

С Днем технического писателя, коллеги! 🎉🎉🎉 Желаем вам поменьше завалов! :-) #давайте_мем

Давайте розыгрыш! Уже совсем скоро нас ждёт классная конференция WriteConf, где соберутся все, кто работает с текстами в IT. Это технические писатели, UX-редакторы, контент-менеджеры, локализаторы и много кто еще. 26 февраля в Москве (и онлайн). Мы были на прошлой WriteConf всей нашей редакцией и нам очень понравилось. В этот раз тоже шикарные доклады, нетворкинг и даже прожарка текстов в прямом эфире и нытинг-сессия 😱 😁 По уже сложившейся традиции разыгрываем билет на конференцию 🎉 Билет офл...

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

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

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

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

Как писать про цифры Числа и числительные — не редкость в технической документации. Вот несколько советов по оформлению, которые позволят читателю не заблудиться в цифрах. ✅ В числах из 5 цифр и более ставьте пробел между разрядами:  10 000 записей ✅ Числа до 10 допустимо писать словами, но большие числа — только цифрами: Доставку переносили два раза Доставку переносили больше 20 раз ✅ Для больших круглых чисел используйте словесно-цифровую форму: Прибыль в 12 млн р...

Тестовое онлайн. Чего ждать? Уже не раз в профессиональных чатах, да и мы на канале, обсуждали тестовые задания и портфолио. А тем временем всё больше работодателей стали давать тестовые задания прямо на собеседовании. Постараемся рассказать об основных видах заданий на собеседованиях, которые были в нашей практике. Вычитка Мы встречали разные варианты: от «вычитать 3 абзаца» до «154 страницы за 40 минут». Ожидания от этих двух заданий абсолютно разные. Разработка структуры документа На таких за...