Size: a a a

Технические писатели

2021 September 06

O[

Olga [olgademoscu] in Технические писатели
Картинка просится на футболку
источник

D

Daria in Технические писатели
источник

V

Valya in Технические писатели
Митболы - «хлебные крошки» мы часто называли
источник

AD

Alyona Devon in Технические писатели
это же шутка?) названия иконок с меню мака кажется стащили
источник

D

Daria in Технические писатели
Да, это из реддита картинка кажется
источник

O[

Olga [olgademoscu] in Технические писатели
Мне такое название в документации к жире попадалось.
https://atlassian.design/components/breadcrumbs/examples - например
источник

VB

Vitaly Belyakov in Технические писатели
как читатель и как писатель ничего криминального в инструкции не увидел. Наоборот, очень удобно отображены иконки, в которые мне же предлагается тыкать) если бы вместо иконки я прочитал «нажмите кнопку-бургер», то завис бы надолго)
Насчёт кнопок в «американском стиле» — а что собно странного? Да, это из microsoft style guide, но не только майкрософт это использует.
источник

OP

Olga Pankina in Технические писатели
#вакансия #техническийписатель #удаленно #wanted_tw

Вакансия: Technical Writer
Компания: Arenadata https://www.youtube.com/watch?v=RKZ7Chty98Y&t=38s
Локация: 100% удаленно (или можно работать в офисе в Москве)
Заработная плата: от 150 тыс. руб. на руки и выше

Что сейчас есть:
- документация на русском языке
- все сборки документации в формате rST и собираются sphinx-doc

Что надо делать:
- собирать информацию у архитекторов, аналитиков и разработчиков
- самостоятельно изучать наши продукты и проходить все описываемые действия на тестовых стендах
- разрабатывать и актуализировать документацию на английском языке
- применять подход Docs as a Code

Кого мы ищем:
- 5+ лет опыта работы техническим писателем
- большой опыт написание различной технической документации на современные IT-продукты (БД, продукты с микросервисной архитектурой, бэкенд, фронтэнд и тд)
- опыт написания документации для разных категорий пользователей
- знание GitHub, опыт с движками генерации статических сайтов и с различными легковесными языками разметки
- опыт работы в консоли, знание Linux на уровне опытного пользователя
- знание английского языка на хорошем уровне для написания документации (Upper Intermediate минимум)

Плюсом будет:
- опыт написания документации на распределённые системы (например, БД, блокчейн)
- опыт программирования на Java/C++
- опыт работы с Antora и Asciidoc
- знание инструментария CI/CD, Docker для задач технической документации

Условия:
Официальное оформление по ТК РФ, белая ЗП;
Cертификация и обучение за счет компании;
Возможность работы удаленно и гибкий график;
Обеспечение техникой для работы (ноутбук, монитор);
Корпоративные курсы английского;
ДМС со стоматологией.

✉️ Контакты: @pankina_hr poe@arenadata.io
источник

AD

Alyona Devon in Технические писатели
у нас в документации не поддерживается вставка иконки, а обозвать ее как-то нужно) вот и спрашиваю, как называется
у меня вопрос не к чужой документации, просто зашла в офиц источник, так как писать нужно на ту же тему)

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

VB

Vitaly Belyakov in Технические писатели
как у вас всё жёстко и сурово)
ну тогда буквально жестами можно описать, «кнопка из трёх чёрточек» ))

>мы просто без болда и в кавычки-елочки ставим. но этой редакционной политике уже 5 лет, хз какая лучше

Применение стилей (например, выделение болдом) гораздо заметнее в тексте. Брать в кавычки уже давно устарело, мне кажется.
источник

BF

Bobba Fett in Технические писатели
Называть может иметь смысл только если их несколько рядом, а если любая из них одна - это меню, этого достаточно.

«Откройте меню в верхнем правом углу (иконка)»

«Нажмите кнопку меню в нижнем левом углу (иконка)»
источник

VB

Vitaly Belyakov in Технические писатели
в том и дело, что по условиям задачи иконки вставлять нельзя. А в том же инстаграме рядом с бургер-кнопкой ещё есть кнопка-плюсик, она тоже вызывает меню)
источник

VB

Vitaly Belyakov in Технические писатели
кстати, эта кнопка есть в ASCII)
источник

Ю

Юлия in Технические писатели
Ох как я вас понимаю!!! У нас тоже раньше иконки не вставить было...
источник

AD

Alyona Devon in Технические писатели
о, супер. если ее только сервис, через который добавляем статьи или браузер пользователя не переведет это в кучку непонятных символов, то то что нужно)
источник
2021 September 07

AD

Alyona Devon in Технические писатели
А кто это присылал когда-то
Это было написано в 2001 первом году?) кажется и сейчас может лечь на процесс срочного релиза без ТЗ 😬 http://www.iconixsoftware.net/AliceUseCaseLand.html#collapse8
источник

AD

Alyona Devon in Технические писатели
А чем дальше в лес тем более четкая инструкция по написанию бизнес требований, инструкций и налаживанию процессов. По сцентом сюрреализма в виде сказки. Получилось даже гениально
источник

A

Alex in Технические писатели
значки в тексте, выделение полужирным вместо кавычек — всё это давно является нормой в веб-типографике с описаниями UI
источник

A

Alex in Технические писатели
хм. хлебные крошки — это же немного другое, из сказки, чтобы не заблудиться
источник

V

Valya in Технические писатели
Не заблудиться в интерфейсе
источник