Pull to refresh
8
0
Даниил @InstaHeat

Техническая документация и редакторская подготовка

Send message

Организация ведения документации и перевода, на примере iondv. framework

Reading time12 min
Views5.2K


Как и у многих команд разрабатывающих большие продукты, при разработке опенсорсного фреймворка для визуального создания веб-приложений iondv.framework возникла задача документирования возможностей системы. Сначала для себя и новых сотрудников. Потом для пользователей. А в настоящее время документация является и важным средством продвижения продукта. И хотя последнее время идёт смещение в сторону медиа материалов (видео уроков), документация важна.


Мы прошли путь от wiki в гитлаб, до структурированной и синхронизированной по двум языкам документации в виде markdown файлов публикуемых в репозитории github. И вот мы начали переход на связку github + Weblate + readTheDocs. Так как статей об этом на хабре мало – ниже о наших ошибках, сложностях и опыте настройки перевода open-source проекта.

Читать дальше →

Как закалялась документация

Reading time5 min
Views4.7K

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

Хочу очертить тот путь, который мы прошли, и рассказать о том, какие решения принимали, и что из этого вырастало.

Читать далее

Создание voice & tone вашего продукта

Reading time5 min
Views6.8K
В статье была затронута тема тональности и голоса продукта. Понятие в наших краях не слишком-то и обсуждаемо, практически не используется осознанно. И, если быть честными, голос и тон обычно входят в брендбуки и аналогичные документы, либо прописываются в неявном виде в редакционных политиках журналов/газет и т.п.

Предлагаю вашему вниманию перевод статьи «Creating your product’s tone and voice» автора Kaja Laura Toczyska. Как обычно, заранее всем спасибо, кто уделит время прочтению.

image
Читать дальше →

Чем занимается UX-писатель?

Reading time7 min
Views14K
Привет, Хабр! Представляю вашему вниманию перевод статьи «What do UX writers do all day?» автора Yael Ben-David.

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

image
Читать дальше →

Information

Rating
Does not participate
Location
Санкт-Петербург, Санкт-Петербург и область, Россия
Date of birth
Registered
Activity