Pull to refresh

«Здравствуйте, я технический писатель»

StarWind Software corporate blog Technical Writing *
Мы все любим читать документацию. Ну, возможно, не все. Есть такие люди, которые вначале экспериментируют с каким-то прибором, доводят его до состояния “почти сломанный” и лишь потом берутся за чтение описания его работы. А некоторые даже не притронутся к нему, не прочитав все бумажки в коробке от корки до корки. Но все согласны, что документация важна и нужна. Даже для предметов, на котором только одна или две кнопки. ( а вот вы знаете, как на iPhone картинку, которая на экране, перевести на “пленку встроенной фотокамеры”? Читаем документацию. RTFM, другими словами, там все описано ).
Читать дальше →
Total votes 18: ↑11 and ↓7 +4
Views 5.4K
Comments 6

Технический писатель: о языках и странах

StarWind Software corporate blog Technical Writing *
Итак, какими же языками пользуется технический писатель в сфере IT?

Английский. THIS IS A MUST, как говорят. Так уж сложилось, что это стандарт в мире информационных технологий. Техписатель в этой сфере просто обязан владеть им вне зависимости от того, какой у него основной рабочий язык. Иначе… увы.
Кстати, что радует, читать документацию на английском легко и приятно ( как и научные статьи, между прочим ). Пишется она обычно простым и доступным для понимания языком.
Часто даже на русском документация сложнее.
Читать дальше →
Total votes 46: ↑38 and ↓8 +30
Views 8.3K
Comments 23

Технический писатель: ты мне — я тебе

StarWind Software corporate blog Technical Writing *
Итак, чем же может заниматься технический писатель? Традиционно технические писатели участвуют в создании:

  • “онлайн-справок” для помощи в использовании программного продукта, пример такой справки — все, что появляется в любой программе по нажатию кнопки “Help”;


Читать дальше →
Total votes 19: ↑17 and ↓2 +15
Views 17K
Comments 9

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

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


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

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

Новые профстандарты от АП КИТ и Минкомсвязи

IT Standards *
19 сентября этого года для обсуждения были представлены 4 новых профессиональных стандарта в области ИТ, которые разрабатываются под эгидой Ассоциации предприятий компьютерных и информационных технологий (АП КИТ) и Министерства связи и массовых коммуникаций (Минкомсвязи).

Новые профстандарты охватывают следующие виды трудовой деятельности:
  • Системный программист
  • Программист высокопроизводительных вычислительных систем
  • Специалист по распределенным вычислительным системам
  • Специалист по технической документации (Технический писатель)

Читать дальше →
Total votes 9: ↑8 and ↓1 +7
Views 3.9K
Comments 3

Дао разработки справочной документации для IT-продукта

Alconost corporate blog Website development *

image
Привет!

Любите читать хелпы? А писать? Думаю, что 99% из вас ответят “НЕТ”.

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

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

Читать дальше →
Total votes 27: ↑21 and ↓6 +15
Views 20K
Comments 12

Переводим с программистского на русский

ABBYY corporate blog Website development *Technical Writing *
Как вы думаете, кто лучше всего знает продукт? PM, или может быть DM? Аналитик? Интерфейс-дизайнер? Ответ на все эти вопросы, скорее всего, будет «нет». По крайней мере, в случае большого проекта. Почему?

Попробуем рассмотреть подробнее:

Главный. Он описывает концепт. Говорит: «Хочу, чтобы тут было синим, а эта кнопка всё уменьшала. А вот здесь, чтобы как в Windows 8 | iOS | в том приложении | лучше, чем у конкурента (ненужное зачеркнуть). И, очевидно, оно должно уметь делать всё красным и подкладывать квадратики».
Читать дальше →
Total votes 69: ↑56 and ↓13 +43
Views 37K
Comments 29

О плохих словах, или Как написать текст, не сделав из него какашку

Website development *
Sandbox
Tutorial
Здравствуйте.
В первой части статьи я расскажу о некоторых стилистических «косяках», которые придают текстам характерный канцелярский унылый стиль. Вторая часть посвящена более серьёзной ошибке, которая, к сожалению, грозит в ближайшее время стать правилом.
Читать дальше →
Total votes 204: ↑180 and ↓24 +156
Views 63K
Comments 167

Цели, задачи и принципы автоматизации

System Analysis and Design *
Работая в компании, которая занимается системной интеграцией, мне приходилось много раз читать и дополнять документы типа ТКП, ТЗ по ГОСТу, Планы приемки и прочее. Проекты по автоматизации предприятий преследовали похожие цели и имели приблизительно одинаковый формат. Одни и те же фразы повторялись из документа в документ.

Я решила собрать самые распространенные фразы, попадавшие в раздел «цели и задачи». И добавить принципы, которых следует придерживаться при формировании решений.

Список не универсальный. Буду рада, если кому-то это поможет при написании документов.

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

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

Читать дальше →
Total votes 15: ↑14 and ↓1 +13
Views 13K
Comments 4

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

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

Читать дальше →
Total votes 8: ↑5 and ↓3 +2
Views 12K
Comments 2

Login или Log in?

Website development *Development of mobile applications *IT Standards *
Sandbox


‘Login’ или ‘log in’? Одно слово или два? Это достаточно распространенный вопрос среди тех, кто пишет на английском языке. Давайте разберемся, как же правильно.

Читать дальше →
Total votes 147: ↑134 and ↓13 +121
Views 73K
Comments 72

Log in или Log on? Front-end или Frontend? Продолжаем разбираться

Website development *Development of mobile applications *IT Standards *


В прошлый раз мы говорили о разнице между login и log in. В продолжение темы — ещё несколько нюансов, о которых вы просили рассказать в комментариях.

Читать дальше →
Total votes 61: ↑56 and ↓5 +51
Views 25K
Comments 33

CoLaboratory: «ProКонтент 2.0». Ближе к пользователю

«Лаборатория Касперского» corporate blog Language localisation *
Есть два типа компаний: первые ориентированы на пользователей, вторые — на свой продукт. По мере того как бизнес растет, часто главным для него становится продукт, который необходимо развивать и поддерживать, а забота о клиенте отходит на второй план.

При всех своих масштабах и линейке более чем из 60 настраиваемых решений «Лаборатория Касперского» действует прежде всего в интересах пользователя. Важная часть нашей работы — тексты: мы общаемся с пользователями наших продуктов с помощью элементов интерфейса и документации.

image

Год назад в «Лаборатории Касперского» прошла первая встреча «ProКонтент» для технических писателей, редакторов, переводчиков и локализаторов. 16 марта 2017 года мы вновь приглашаем к себе всех желающих, чтобы раскрыть свои секреты и поговорить о том, что нас объединяет. О контенте.
Читать дальше →
Total votes 13: ↑13 and ↓0 +13
Views 2.2K
Comments 0

Термины «фронтенд», «клиентская сторона» и «интерфейс» — как употреблять и не облажаться

Лайв Тайпинг corporate blog Website development *
До работы редактором и контент-маркетологом в компании Лайв Тайпинг я два года занимался гуманитарными текстами: редактировал и писал статьи про моду, музыку, кино, изобразительное искусство, социологию и тому подобное. От меня требовалось не столько корректно донести смысл, сколько добиться яркого образа, создать настроение и подарить читателю эмоцию. Это развязывает руки в отношениях со словами: прежде имевшие точный смысл, они становятся сырьём для аллегорий, метафор и других литературных приёмов.

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

При работе над кейсом проекта Designet я поймал себя на том, что считаю термины «фронтенд», «клиентская сторона» и «интерфейс» синонимами. Чтобы расставить все точки над i и больше их не путать, я написал эту памятку. Надеюсь, что она поможет не только мне, но и коллегам — редакторам, копирайтерам, техническим журналистам, маркетологам, менеджерам проектов и всем, кто не имеет прямого отношения к программированию.


Читать дальше →
Total votes 24: ↑15 and ↓9 +6
Views 15K
Comments 53

CoLaboratory: конференция ProКонтент

«Лаборатория Касперского» corporate blog Language localisation *Conferences
Если вы занимаетесь подготовкой контента или руководите процессом его создания, то наверняка задумывались (или еще задумаетесь), зачем вы все это делаете, читает ли кто-нибудь выстраданные вами тексты и нужны ли они вообще кому-то. Уже совсем скоро, 20 марта 2018 года мы собираемся ответить на эти и не только вопросы: у нас в офисе пройдет очередная конференция «ProКонтент» для технических писателей, редакторов и локализаторов.


Читать дальше →
Total votes 6: ↑4 and ↓2 +2
Views 1.3K
Comments 0

Второй митап Write the Docs Moscow. House Techwriters: не забывайте что мы существуем

Conferences Technical Writing *
Хотя второй по счету митап Write the Docs Moscow состоялся уже месяц назад, опубликовать отчет и краткие конспекты докладов никогда не поздно. Мы успели обсудить ну практически все: от документирования RESTful API до профессиональных траекторий техписателя.

Митап, кстати собрал не только «техписательское гетто», но и широкий круг других специалистов, кто так или иначе работает испытывает боль с документацией на проекте: тимлиды, аналитики, тестировщики и даже один технический директор.

Читать далее
Total votes 11: ↑11 and ↓0 +11
Views 1.8K
Comments 0

50 вопросов для работы над документацией

ISPsystem corporate blog Studying in IT
Как бы ни старался UX-дизайнер, не сможет человек с улицы разобраться в интерфейсе управления космическим кораблём без подсказки. И даже не с улицы. Просто потому, что ракета большая и настроек много.

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

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


Читать дальше →
Total votes 20: ↑20 and ↓0 +20
Views 7.8K
Comments 0

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

Parallels corporate blog Development Management *Project management *Technical Writing *

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


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

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

Пользовательская документация: что делает её плохой, и как это исправить

ISPsystem corporate blog Development Management *Studying in IT Product Management *
image

Документация к софту — это просто набор статей, но даже они могут вывести из себя. Сначала долго ищешь нужную инструкцию, потом разбираешься в малопонятном тексте, делаешь как написано, а проблема не решается. Ищешь другую статью, нервничаешь… Через час плюёшь на всё и уходишь. Так работает плохая документация. Что делает её такой, и как это исправить — читайте под катом.
Читать дальше →
Total votes 27: ↑24 and ↓3 +21
Views 7K
Comments 7

К чему приложить прикладного лингвиста?

Veeam Software corporate blog Studying in IT IT career
“Что за дело? Это многих славных путь.”
Н.А. Некрасов

Всем привет!

Меня зовут Карина, и я “совместитель” — совмещаю учёбу в магистратуре и работу технического писателя в Veeam Software. О том, как у меня это вышло, я и хочу рассказать. Заодно кто-то узнает, как можно прийти в эту профессию, и какие я вижу для себя плюсы и минусы в работе во время учебы.

Я работаю в Veeam без году неделю полгода с небольшим, и это были самые насыщенные полгода моей жизни. Я пишу техническую документацию (и учусь её писать) — сейчас я занимаюсь руководством по Veeam ONE Reporter (вот оно) и гайдами по Veeam Availability Console (про нее была статья на Хабре) для конечных пользователей и реселлеров. Еще я из тех, кому сложно парой слов ответить на вопрос «Откуда ты приехала?». Вопрос «Как ты проводишь свободное время?» тоже не из простых.

image

Взгляд работающего студента, когда ему жалуются на недостаток свободного времени
Читать дальше →
Total votes 25: ↑23 and ↓2 +21
Views 3.5K
Comments 2
1