Рубрика «технический писатель»

в 11:16, , рубрики: asciidoc, asciidoctor, docs as code, documentation, PDF, генератор статических сайтов, техническая документация, технический писатель

В статье приводится практический опыт перехода от “офисных” документов к подходу Docs‑as‑Code на примере проекта ODS (Open Documentation Standard). Рассматриваются причины отказа от MS Word и выбор AsciiDoc, версионирование документации в Git, автоматизацию сборки PDF и публикацию документации на сайте, используя генератор статических сайтов – Antora.

Эта статья о проекте ODS (Open Documentation Standard) – открытом стандарте и инструментарии для автоматизации процессов создания и поддержки технической документации в ИТ и других проектах.
(Не связан с форматом OpenDocument Spreadsheet (.ods) или проектами Open Data.)

В открытом доступе находятся Читать полностью »

в 11:27, , рубрики: bercut, dita, dita open toolkit, doc-as-code, XML, документация, пользовательская документация, техническая документация, технический писатель, форматы документов

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

DITA расшифровывается как Darwin Information Typing Architecture. Фактически это формат, основанный на Читать полностью »

в 16:40, , рубрики: rtfm, user guide, документация, инструкция, интерфейс, описание, пользовательская документация, руководство пользователя, технический писатель

В случае возникновения критической ошибки обновления:
1. Установите причину ошибки.
2. Устраните причину ошибки.

Документация Microsoft

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

Читать полностью »

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

Привет!

Меня зовут Дима, я работаю техническим писателем в UDV Group, описываю разрабатываемые продукты для внешних и внутренних пользователей.

Задумывались ли вы когда-нибудь о том, кто объясняет сложное так, чтобы было понятно всем? Кто превращает техническую жаргонизированную речь разработчиков в простые инструкции, которые может прочитать любой — от новичка до супер-специалиста?

Читать полностью »

в 19:25, , рубрики: профессиональное сообщество, сообщество экспертов, теги, технические писатели, технический писатель, чат

Привет! Меня зовут Арина Балерина, я — технический писатель, а это значит, что я умею писать инструкции к тому, чем вы пользуетесь каждый день, будь то API или холодильник.

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

Речь пойдёт о крупнейшем в России сообществе технических писателей, вот оно:

https://t.me/technicalwriters

Читать полностью »

в 13:16, , рубрики: ит-рынок, научпоп, русский язык, технический писатель

Нужные люди без профессии

Для меня, студента, а потом выпускника московского технического вуза по специальности «Прикладная математика», середина 1990-х годов выглядела дивным новым миром и взрывом возможностей. Появлялись новые российские компании, новые продукты, приходили в Россию иностранные компьютерные и софтверные компании. И всё это было окружено многочисленными выставками, всевозможными семинарами, презентациями, журналами и еженедельниками.

Читать полностью »

в 4:15, , рубрики: AI, chatgpt, restructuredtext, sphinx, sphinx docs, автоматизация, документация, искусственный интеллект, рабочие процессы, технический писатель

Всем привет! Меня зовут Севара Ахтямова и я работаю техническим писателем — аналитиком около 4 лет. В этой статье я расскажу, как AI помог мне справиться с рабочей рутиной — от генерации toctree до отладки сборки Sphinx-документации. Всё это — на реальных задачах. Я постаралась собрать побольше примеров из личного опыта. Надеюсь, не слишком много.

Читать полностью »

в 14:30, , рубрики: зарплаты в it, ИИ, искусственный интеллект, нейросети, рынок труда, создание документации, технический писатель, тренды будущего

Разберём, как устроен рынок труда для техписов в России и США, вооружившись данными за 2023–2024 годы. Поговорим о зарплатах, условиях работы и трендах, которые определяют будущее профессии. Заодно выясним, почему спрос на специалистов по документации продолжает расти вместе с развитием технологий и какие перспективы открываются перед теми, кто готов учиться, адаптироваться и прокачивать свои навыки.

Читать полностью »

в 12:16, , рубрики: qa, документация, ИИ, нейросети, техническая документация, технический писатель, чат-бот, Чат-боты, чатбот, чатботы

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

Часть первая

Данная статья не предполагает каких-то заумных и крайне неочевидных советов по написанию и проверке технической документации. Многие из перечисленных «советов» многим покажутся очевидными, но из раза в раз, анализируя документацию наших пользователей, мы сталкиваемся с одними и теми же банальными ошибками, которые чаще всего происходят из-за фактора «забыл». Так что данный пост можно расценить как памятку не техническому писателю.

Приятного чтения.

Читать полностью »

123
Главная   |  Архив новостей  |   Android  |   Google  |   Apple  |   Microsoft  |   Информационная безопасность  |   Веб – разработка
Публикации RSS  |  Комментарии RSS
https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js