Как стать автором
Обновить

Mozilla обновила MDN и готовится к запуску MDN Plus

Время на прочтение 1 мин
Количество просмотров 4.7K
Разработка веб-сайтов *CSS *JavaScript *HTML *

Mozila обновила ресурс MDN (Mozilla Developer Network). Изменили внешний вид веб-портала, улучшили систему поиска и переработали сортировку по темам. Вместе с этим анонсировали премиальную подписку MDN Plus, позволяющую персонализировать документацию под собственные нужды.

Читать далее
Всего голосов 14: ↑14 и ↓0 +14
Комментарии 3

Mozilla запустила платный сервис MDN Plus

Время на прочтение 2 мин
Количество просмотров 9.7K
Разработка веб-сайтов *CSS *JavaScript *HTML *IT-компании

Mozilla запустила новый платный сервис MDN Plus, который дополнит такие коммерческие инициативы, как Mozilla VPN и Firefox Relay Premium. Стоимость подписки составит $10 в месяц или $100 в год.

Читать далее
Всего голосов 10: ↑10 и ↓0 +10
Комментарии 15

Команда GitHub представила нативную поддержку математических выражений в md-файлах

Время на прочтение 2 мин
Количество просмотров 3.8K
Математика *GitHub *Подготовка технической документации *

В блоге GitHub сообщили, что математические формулы и выражения — важная часть обмена информацией между разработчиками, инженерами и учеными. Поэтому теперь в GitHub появилась нативная функция для простой записи выражений в Markdown.

Читать далее
Всего голосов 15: ↑15 и ↓0 +15
Комментарии 13

Заходят русский, англичанин и китаец в программу…

Время на прочтение 6 мин
Количество просмотров 5K
Блог компании «Лаборатория Касперского»
Привет, Хабровчане!
Что вы думаете про нашу техническую документацию и локализации продуктов, если вам доводилось с ними сталкиваться? И читаете ли вы документацию вообще?
В свою очередь, мы хотим рассказать вам, как ЛК удается делать так, чтобы и русский, и англичанин, и китаец одинаково легко обращались с нашими программами. Больше всех об этом знает руководитель отдела локализации и разработки технической документации Татьяна Родионова.


image― Татьяна, насколько это вообще объемная работа, как много сотрудников числится в вашем отделе?

― Сейчас в отделе работают 48 человек. По функциям все они делятся на 4 группы. Группа технического документирования разрабатывает материалы, которые помогают пользователю разобраться в программе. Это тексты графического интерфейса продуктов, справка, интегрированная в продукт, а также сопроводительные документы, такие как «Руководство пользователя». Тексты пишут технические писатели.
Локализацией текстов на языки занимаются переводчики и инженеры группы локализации. Сегодня мы локализуем наши продукты на 33 языка. Основные языки ― русский, английский, немецкий, французский и для некоторых продуктов ― китайский. Понятно, что локализовать продукт на 33 языка силами только штатных сотрудников невозможно. В помощь мы привлекаем переводческие агентства и носителей языков по всему миру.
Читать дальше →
Всего голосов 11: ↑8 и ↓3 +5
Комментарии 1

Будни технического писателя: от CIS до Стругацких

Время на прочтение 5 мин
Количество просмотров 9.3K
Блог компании Positive Technologies Разработка веб-сайтов *Подготовка технической документации *
В любой компании, которая разрабатывает программное обеспечение, всегда есть множество задач, связанных с ведением документации и ее переводом на разные языки (особенно если компания международная). В нашем случае актуальны обе эти проблемы, а поток задач весьма значительный, поэтому на отдел технической документации ложится большая нагрузка.

В Positive Technologies технические писатели прикладывают свою руку ко всем текстам, рождающимся в недрах компании, — от сугубо технических (сопроводительная документация к продуктам, корпоративные, отраслевые стандарты) до высокохудожественных опусов с аллюзиями на Стругацких (см. легенды соревнований CTF на PHDays 2012). Если вы хотите узнать о том, как мы контролируем сроки и качество выполнения столь разноплановых задач, — добро пожаловать под кат.
Читать дальше →
Всего голосов 24: ↑22 и ↓2 +20
Комментарии 4

Постановка задач и расчет трудозатрат на разработку документации в IT компании

Время на прочтение 5 мин
Количество просмотров 12K
Блог компании Docsvision ECM/СЭД *
Вопрос о том, как ставить задачи и оценивать трудозатраты техписателей, поднимается почти на каждом вебинаре, конференции и встрече, посвященной документированию. В чем сложность? Почему, в отличие от оценки времени, затраченного программистами, тестировщиками и другими сотрудниками отдела разработки, именно трудозатраты документаторов постоянно вызывают дискуссии?
Попробую объяснить и показать, как можно избежать проблем в этом вопросе, используя систему управления задачами (как это работает — покажу на примере используемой нами системы Actionspace). Технический писатель, Лена Толмачева.

Читать дальше →
Всего голосов 8: ↑5 и ↓3 +2
Комментарии 2

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

Время на прочтение 12 мин
Количество просмотров 75K
Учебный процесс в IT Подготовка технической документации *
Перевод

Введение


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

Эти правила — не моё собственное изобретение. Скорее, я просто сформулировал их из того опыта, который появился благодаря общению со многими талантливыми техническими и литературными редакторами за более чем десять лет работы. Всё, что я понял в этом деле, сформировалось потому, что другие показали мне путь. У меня не находится достаточно слов, чтобы выразить им в полной мере мою благодарность.

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

Итак — эти 7 правил:
  1. Скука убивает
  2. Прежде чем начать, выясните точно для себя, какие действия вы ожидаете от читателя, осилившего ваш труд
  3. Пишите в соответствии с правильно сформированной структурой
  4. Избегайте неоднозначных местоимений
  5. Ясность = иллюстрации + слова
  6. Когда имеете дело с понятиями, концепциями и т.п., используйте логическую иллюстрацию и пример
  7. Не опасайтесь переделок

Читать дальше →
Всего голосов 26: ↑25 и ↓1 +24
Комментарии 17

Информационная архитектура и технология DITA. По мотивам лекции в Яндексе

Время на прочтение 21 мин
Количество просмотров 12K
Блог компании Яндекс XML *
Darwin Information Typing Architecture (DITA) — XML-технология для автоматизации процессов, связанных с технической документацией. За время существования DITA накопилось большое количество разнообразных возможностей, подходов к организации контента, а также конкретных механизмов их реализации. Запутаться в них немудрено, и это часто приводит к появлению непонятных, неэффективных и просто неудобных решений по автоматизации документирования. Директор по проектам компании «Философт» Михаил Острогорский раскладывает всё по полочкам.


Предисловие


Предлагаемая статья написана по мотивам небольшого доклада, сделанного автором на одном из «Гипербатонов», которые время от времени бывают в Яндексе. Не то что бы я был слишком недоволен собой как оратором, но в этом случае публиковать дословную расшифровку устной речи — не лучшая идея, на мой взгляд.
Всего голосов 27: ↑27 и ↓0 +27
Комментарии 0

Операция по спасению 25000 мануалов закончилась полным успехом

Время на прочтение 2 мин
Количество просмотров 11K
Профессиональная литература *Краудсорсинг


Буквально на днях на Geektimes публиковалась новость о том, что «из-за экономических проблем книжный магазин Manuals Plus в штате Мэриленд вынужден закрыться. В понедельник 17 августа они выкинут всю свою коллекцию мануалов. Это огромная коллекция, которая содержит справочные руководства к разнообразной технике с 30-х годов прошлого века». Несколько энтузиастов узнали о проблеме, и решили привлечь добровольцев к спасению всей этой информации.

Был дан клич в социальные сети, и, к удивлению инициаторов, нашлось несколько десятков человек, которые изъявили желание помочь. С утра Джейсон Скотт (Jason Scott), автор идеи по спасению мануалов, уже был в магазине в 8 утра. С собой он привез 400 коробок (их подарил один из тех, кто решил помочь проекту) для перевозки материалов. К этому же магазину подошли и волонтеры — около 20 человек. Работа началась.
Читать дальше →
Всего голосов 23: ↑15 и ↓8 +7
Комментарии 10

История и опыт использования машинного перевода. Лекция Яндекса

Время на прочтение 9 мин
Количество просмотров 5.6K
Блог компании Яндекс Локализация продуктов *Машинное обучение *
В сентябре прошёл шестой Гипербатон — конференция Яндекса обо всём, что связано с технической документацией. Мы опубликуем несколько лекций с Гипербатона, которые, на наш взгляд, могут быть наиболее интересны читателям Хабра.


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

Начнем с доклада наших коллег. Приглашаю Ирину Рыбникову и Анастасию Пономарёву — они расскажут об опыте Яндекса по внедрению машинного перевода в наши процессы локализации.
Всего голосов 17: ↑16 и ↓1 +15
Комментарии 3

Новый взгляд на документирование API и SDK в Яндексе. Лекция на Гипербатоне

Время на прочтение 19 мин
Количество просмотров 6.4K
Блог компании Яндекс API *Яндекс API *Локализация продуктов *Подготовка технической документации *
Меня зовут Андрей Поляков, я руководитель группы документирования API и SDK в Яндексе. Сегодня я хотел бы поделиться с вами докладом, который я и моя коллега, старший разработчик документации Юлия Пивоварова, прочитали несколько недель назад на шестом Гипербатоне.


Светлана Каюшина, руководитель отдела документирования и локализации:
— Объемы программного кода в мире в последние годы сильно выросли, продолжают расти, и это влияет на работу технических писателей, которым приходит все больше задач на разработку программной документации и документирования кода. Мы не могли обойти стороной эту тему, посвятили ей целую секцию. Это три взаимосвязанных доклада, посвященных унификации разработки программной документации. Я приглашаю наших специалистов по документированию программных интерфейсов и библиотек Андрея Полякова и Юлию Пивоварову. Передаю им слово.
Всего голосов 21: ↑20 и ↓1 +19
Комментарии 0

Ландшафт сервисов облачного машинного перевода. Лекция в Яндексе

Время на прочтение 16 мин
Количество просмотров 3.5K
Блог компании Яндекс Локализация продуктов *Машинное обучение *
Это последний доклад с шестого Гипербатона, который мы опубликуем на Хабре. Григорий Сапунов из Intento поделился подходом к оценке качества сервисов облачного машинного перевода, рассказал о результатах оценки и главных отличиях между доступными сервисами.


— Меня зовут Григорий Сапунов, я расскажу про ландшафт сервисов облачного машинного перевода. Мы измеряем этот ландшафт уже больше года, он очень динамичен и интересен.
Всего голосов 14: ↑14 и ↓0 +14
Комментарии 0

Вредные советы: как правильно писать техническую документацию?

Время на прочтение 7 мин
Количество просмотров 11K
Блог компании Parallels Управление разработкой *Управление проектами *Подготовка технической документации *

Советы по грамотному написанию технической документации для пользователей.
Часть 1


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

На этот раз под катом – руководство нашего технического писателя Андрея Старовойтова, которое поможет сделать вашу документацию для пользователей проще и понятнее (описанные приемы применяют при документировании своих продуктов Apple, Microsoft и другие компании).
Читать дальше →
Всего голосов 24: ↑22 и ↓2 +20
Комментарии 4

Вредные советы: как правильно писать техническую документацию? Часть вторая

Время на прочтение 10 мин
Количество просмотров 6.3K
Блог компании Parallels Управление разработкой *Управление проектами *IT-компании Подготовка технической документации *
Советы по грамотному написанию технической документации для пользователей.
Часть 2


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

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

В этой части мы подробно разберем топики, из которых в основном состоит пользовательская документация (особенно User’s Guide) – а именно task-топики, в которых рассказывается, как решить конкретную задачу.

image
Читать дальше →
Всего голосов 13: ↑12 и ↓1 +11
Комментарии 4

Как мы искали замену MS Word, а вместо этого внедрили новый процесс управления документами

Время на прочтение 8 мин
Количество просмотров 14K
Управление разработкой *Управление проектами *Управление продуктом *Atlassian *
Из песочницы
MS Word регулярно подкидывает нам «сюрпризы»: «съехавшие» скриншоты, «плывущие» таблицы, пустые страницы при печати. Эта статья о том, как мы искали замену MS Word, (спойлер — не нашли), а нашли возможность глобально улучшить наш процесс работы с документацией.

image
Читать дальше →
Всего голосов 9: ↑7 и ↓2 +5
Комментарии 30

Принципы документирования и локализации, или как получить хорошую локализацию минимальными затратами

Время на прочтение 14 мин
Количество просмотров 3.7K
Блог компании Naumen Локализация продуктов *
Всем привет!

Меня зовут Денисов Александр. Я работаю в компании Naumen и отвечаю за документирование и локализацию программного продукта Naumen Contact Center (NCC).

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

image
Читать дальше →
Всего голосов 10: ↑9 и ↓1 +8
Комментарии 2

Теперь сапожник с сапогами, или Как у нас появился свой стайл гайд

Время на прочтение 4 мин
Количество просмотров 4K
Блог компании Veeam Software Учебный процесс в IT Карьера в IT-индустрии
Предполагаю, что вам, уважаемые читатели, в своей работе доводилось иметь дело с технической документацией и, возможно, даже с теми, кто ее создает — с техническими писателями. А в нашем блоге вы могли познакомиться с техническим писателем из команды Veeam.

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


КДПВ обманчива — никакое это не чудо, а такая же работа, как и у всех остальных коллег из R&D. Однако у тех, кто создает гайды, есть волшебные слова свои гайды по созданию гайдов! Вот такая вот рекурсия.

Подробнее — в рассказе моей коллеги Дарьи Шалыгиной.
Читать дальше →
Всего голосов 11: ↑11 и ↓0 +11
Комментарии 1

Бесплатный онлайн-курс «Техническая документация в IT-проектах»

Время на прочтение 2 мин
Количество просмотров 9.9K
Я пиарюсь
Как сделать так, чтобы документацию не забывали писать? Как сделать так, чтобы документация решала реальные проектные задачи, а не писалась «для галочки»? Какая документация вообще нужна в вашем проекте?

Пора обо всём этом поговорить!

Встречайте: открытый и бесплатный онлайн-курс «Техническая документация в IT-проектах».

http://documentat.io/courses/open-course/


Читать дальше →
Всего голосов 3: ↑3 и ↓0 +3
Комментарии 0

Техническая документация в разработке ПО: кто, зачем, когда и как описывает проект

Время на прочтение 6 мин
Количество просмотров 58K
Управление разработкой *Подготовка технической документации *
Из песочницы
image

Привет! Меня зовут Даша Григорьева, я технический писатель в компании 65apps. Мы занимаемся разработкой сложных мобильных решений, и моя задача — подготовка технической документации по проектам. Очень часто роль технического писателя бывает недооцененной в компании (не у нас, конечно). Поэтому я хочу рассказать, зачем компании-разработчику нужен такой специалист, что такое технический проект, чем он отличается от ТЗ и почему это все необходимо для разработки мобильного приложения.
Читать дальше →
Всего голосов 12: ↑11 и ↓1 +10
Комментарии 22

Как мы в «Активе» пишем пользовательскую документацию. Почему это важно

Время на прочтение 5 мин
Количество просмотров 5K
Блог компании «Актив» Анализ и проектирование систем *Подготовка технической документации *

Что пользователь хочет видеть в пользовательской документации? Что его в ней раздражает? Эти вопросы задаёт себе каждый, кто пишет такую документацию, но далеко не каждый правильно отвечает на них. Совсем небольшой процент пользователей читает документацию. Давайте разберёмся, почему так и как сделать пользовательскую документацию эффективной и изменить отношение пользователей к ней.


Читать дальше →
Всего голосов 8: ↑8 и ↓0 +8
Комментарии 7