Маша дело говорит. Фраза номер 1 в моем рейтинге — «Надо вчера». Это как раз последствие «Мы потом напишем». Вот цитата из гайда Microsoft на русском:

«Разработчики часто думают, что в продукте текст нужен только для документации или техподдержки: "Сначала мы напишем код, а потом пригласим кого-то, и он объяснит, что мы тут наразрабатывали." На самом деле важные тексты часто пишутся в процессе разработки. И именно этот текст чаще всего видят пользователи.

Понятный текст — очень важная часть работающего интерфейса. Лучше встроить работу с профессиональным писателям и редакторами в дизайн-процессы. Сделайте так, чтобы они на ранних этапах приступали к работе, ведь проблемы с формулировками часто вскрывают проблемы с дизайном. Если у вашей команды есть проблемы с объяснением дизайна, часто улучшения нужны дизайну, а не объяснениям.»

Налоговая служба Украины написала документацию к своему электронному кабинету на Sphinx/reST. В сайте узнаётся тема Read the Docs, можно скачать PDF и EPUB. Я считаю, для госоргана это очень круто и современно.

https://cabinet.tax.gov.ua/help/intro.html

Не хватает только кода на гитхабе и простого канала обратной связи. Нашёл баг, ищу как зарепортить. :)

И мы снова на связи!

Salesforce заопенсорсили свой проект — Metro. Он создавался техническим писателем компании как внутренняя тулза. Это скрипт\приложение на Python, который преобразовывает Google Docs или Salesforce Quip в страницы которые понимает Confluence. Проект находится в активной разработке, доки можно глянуть в readthedocs репе. (зачем было разносить это всё по разным местам — решительно неясно)

#tool #en

Привет!

Если вы читали описание канала, то могли заметить, что я работаю техрайтером в компании Valor Software (на самом деле нас тут уже двое.) Так вот, случилось так, что мы ищем новых людей (техрайтеров, офк). Если вы живете в Украине, но будет еще круче, если вы живете в Харькове, и ищете работу — гоу к нам!

У нас приятно, бродит три кота, офис около реки и все оч даже адекватные. Стек компании — JS, TS, Node, Angular, а скоро, возможно, будет и React. Стек техрайтерский — зависит от проекта, но скорее всего по классике, может быть Конфлюенс, может быть статический сайт с Markdown, может быть Zendesk. Если не устраивает что-то по технологиям, вдруг вы ненавидите Zendesk и фанатеете от Asciidoc, — мы открыты к предложениям, обсудим. У нас довольно плоская управленческая структура, есть CEO и есть вся Команда, никаких "эффективных менеджеров" и прочей лабуды, но печеньки таки вкусные и они есть :} А, а еще у нас есть опция релокейта!

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

Контакты:

Cвязаться с HR напрямую:
anna.siver@valor-software.com
elena.malko@valor-software.com

Основное контактное мыло:
contact@valor-software.com

со мной можно связаться прямо через ТГ, пишите.

#vacancy #career

Частенько слышу про замкнутый круг "не берут на работу без опыта, где взять опыт, если не берут на работу без него" и вот вам молниеносное решение проблемы — Hacktoberfest.

Вот вам отфильтрованный по нужным параметрам и лейблам поиск по Гитхабу, контрибьють — не хочу! Есть таски на все уровни скилла и познаний, дерзайте!

On a side note: наша библиотека ngx-bootstrap тоже участвует в Hacktoberfest

#vacancy #career #en

https://twitter.com/zachlieberman/status/1179789258724446208

#example #en

Немного про UI/UX

https://dou.ua/lenta/articles/ux-guide/

#uiux #ru

Несколько дельных советов UX писателям о том, как повысить свою визибилити (простите я устал) и получить больше признания а работу, которую вы делаете!

Words matter. Writers matter. You matter.

https://medium.com/dropbox-design/getting-a-seat-at-the-table-as-a-ux-writer-da63303d5b1d

#uiux #en #article #resource

Как быстро создавать новые документы в Гугл-доках

Вводите в адресной строке:

— Документ: doc.new
— Таблица: sheet.new
— Презентация: slide.new
— Форма: form.new

https://habr.com/ru/post/414757/

#DocsAsCode #ru #article

Самое раннее из известных технических руководств на английском языке, о том, как работать с астрономическими инструментами, было написано Джеффри Чосером в 1391 году.

https://en.wikipedia.org/wiki/A_Treatise_on_the_Astrolabe

#vintage #en

Переведенный курс Тома Джонсона по документированию API обзавёлся сайтом:

https://starkovden.github.io/

#API #resource #ru

Доступны записи API THE DOCS, AMSTERDAM:

- Lorna Jane Mitchell: GitHub as a Landing Page
- Aaron Verber: Leaping Forward: Finding the Future of Your API Docs
- Sven Strack: Engineer Stunning (API) Documentation
- Jaap Brasser: Advancing Your API Strategy in an Infrastucture World
- Anthony Roux: What Makes an API Product Successful
- Maria Garcia: Bulletproofing Your APIs: Why Users' Feedback Matters
- Mark Simpson, Alexandra Stramarko: Business Integration Made Easy with APIs
- Kelsey Lambert, Sejal Parikh: An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesforce
- Alvaro Navarro: Effective API Governance: Lessons Learnt
- Phil Sturgeon: API Descriptions as Production Code
- Steph Shin: How to Embed UX Thinking in your Next API

https://pronovix.com/event/api-docs-amsterdam-2019

#conference #video #en

Друзья, по мотивам регулярных вопросов из зала набросал статью о том, дружат ли agile и управление знаниями https://habr.com/ru/post/472612/ . Очень жду вас в комментариях :)

Fantastique.

Шикарнейшая подборка инфографико-инструкций, описывающих как работают популярные алгоритмы, не используя ни единого слова, как инструкции IKEA, но про другое.

Более точное описание на самом сайте: "IDEA is a series of nonverbal algorithm assembly instructions, [...]. The instructions explain how various popular algorithms work, entirely without text. This also allows the instructions to be understood interculturally."

https://idea-instructions.com/

#visual #en #example