#пользовательская_документация — Public Fediverse posts

Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации

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

https://habr.com/ru/companies/bercut/articles/951260/

#dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml #форматы_документов #docascode #техническая_документация #bercut

Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации

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

https://habr.com/ru/companies/bercut/articles/951260/

#dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml #форматы_документов #docascode #техническая_документация #bercut

Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации

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

https://habr.com/ru/companies/bercut/articles/951260/

#dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml #форматы_документов #docascode #техническая_документация #bercut

Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации

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

https://habr.com/ru/companies/bercut/articles/951260/

#dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml #форматы_документов #docascode #техническая_документация #bercut

Правки, конфликты, редактура… релиз! Один рабочий день технического писателя Феди в IT-компании

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза .

https://habr.com/ru/companies/bercut/articles/952952/

#технический_писатель #документация #релиз #техническая_документация #редактор #работа_в_команде #подготовка_технической_документации #пользовательская_документация #рабочий_день_в_ит #bercut

Правки, конфликты, редактура… релиз! Один рабочий день технического писателя Феди в IT-компании

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза .

https://habr.com/ru/companies/bercut/articles/952952/

#технический_писатель #документация #релиз #техническая_документация #редактор #работа_в_команде #подготовка_технической_документации #пользовательская_документация #рабочий_день_в_ит #bercut

Правки, конфликты, редактура… релиз! Один рабочий день технического писателя Феди в IT-компании

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза .

https://habr.com/ru/companies/bercut/articles/952952/

#технический_писатель #документация #релиз #техническая_документация #редактор #работа_в_команде #подготовка_технической_документации #пользовательская_документация #рабочий_день_в_ит #bercut

Правки, конфликты, редактура… релиз! Один рабочий день технического писателя Феди в IT-компании

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза .

https://habr.com/ru/companies/bercut/articles/952952/

#технический_писатель #документация #релиз #техническая_документация #редактор #работа_в_команде #подготовка_технической_документации #пользовательская_документация #рабочий_день_в_ит #bercut

Повышаем качество документации с помощью LLM

Привет, Хабр! Меня зовут Катя, я лидирую Gramax , open source-платформу для управления технической документацией. О Gramax мы писали ранее тут . В этой статье расскажу о Gramax Check — сервисе для автоматических проверок текста на базе LLM. По сути — нашей версии «Главреда», но с настраиваемыми правилами. Интересно, давай!

https://habr.com/ru/companies/gram_ax/articles/912950/

#главред #линтер_vale #спеллчекер #пользовательская_документация #документация_по #документация_it #техническая_документация #редактура

Повышаем качество документации с помощью LLM

Привет, Хабр! Меня зовут Катя, я лидирую Gramax , open source-платформу для управления технической документацией. О Gramax мы писали ранее тут . В этой статье расскажу о Gramax Check — сервисе для автоматических проверок текста на базе LLM. По сути — нашей версии «Главреда», но с настраиваемыми правилами. Интересно, давай!

https://habr.com/ru/companies/gram_ax/articles/912950/

#главред #линтер_vale #спеллчекер #пользовательская_документация #документация_по #документация_it #техническая_документация #редактура

Повышаем качество документации с помощью LLM

Привет, Хабр! Меня зовут Катя, я лидирую Gramax , open source-платформу для управления технической документацией. О Gramax мы писали ранее тут . В этой статье расскажу о Gramax Check — сервисе для автоматических проверок текста на базе LLM. По сути — нашей версии «Главреда», но с настраиваемыми правилами. Интересно, давай!

https://habr.com/ru/companies/gram_ax/articles/912950/

#главред #линтер_vale #спеллчекер #пользовательская_документация #документация_по #документация_it #техническая_документация #редактура

Повышаем качество документации с помощью LLM

Привет, Хабр! Меня зовут Катя, я лидирую Gramax , open source-платформу для управления технической документацией. О Gramax мы писали ранее тут . В этой статье расскажу о Gramax Check — сервисе для автоматических проверок текста на базе LLM. По сути — нашей версии «Главреда», но с настраиваемыми правилами. Интересно, давай!

https://habr.com/ru/companies/gram_ax/articles/912950/

#главред #линтер_vale #спеллчекер #пользовательская_документация #документация_по #документация_it #техническая_документация #редактура

От новостей до идей клиентов: управляем ченджлогом и роадмапом

Всем привет! На связи «Инферит Клаудмастер». Я Милена, технический писатель, и пару месяцев назад уже делилась в статье , как в две руки актуализирую портал документации, чтобы вся информация в нём была актуальная и полезная. На этот раз хочу рассказать: - о том, почему ченджлог и роадмап — пользовательская документация, - о ключевых преимуществах ведения обоих видов документации, - об удачных и оригинальных примерах их ведения с точки зрения визуального представления.

https://habr.com/ru/companies/inferit/articles/849924/

#ченджлог #changelog #роадмап #roadmap #пользовательская_документация #документация #release_notes

От новостей до идей клиентов: управляем ченджлогом и роадмапом

Всем привет! На связи «Инферит Клаудмастер». Я Милена, технический писатель, и пару месяцев назад уже делилась в статье , как в две руки актуализирую портал документации, чтобы вся информация в нём была актуальная и полезная. На этот раз хочу рассказать: - о том, почему ченджлог и роадмап — пользовательская документация, - о ключевых преимуществах ведения обоих видов документации, - об удачных и оригинальных примерах их ведения с точки зрения визуального представления.

https://habr.com/ru/companies/inferit/articles/849924/

#ченджлог #changelog #роадмап #roadmap #пользовательская_документация #документация #release_notes

От новостей до идей клиентов: управляем ченджлогом и роадмапом

Всем привет! На связи «Инферит Клаудмастер». Я Милена, технический писатель, и пару месяцев назад уже делилась в статье , как в две руки актуализирую портал документации, чтобы вся информация в нём была актуальная и полезная. На этот раз хочу рассказать: - о том, почему ченджлог и роадмап — пользовательская документация, - о ключевых преимуществах ведения обоих видов документации, - об удачных и оригинальных примерах их ведения с точки зрения визуального представления.

https://habr.com/ru/companies/inferit/articles/849924/

#ченджлог #changelog #роадмап #roadmap #пользовательская_документация #документация #release_notes

Почему светофор важнее Шекспира? Про примечания в технических текстах

У химиков есть известная байка, которую они любят рассказывать молодому поколению. Главный герой этой истории — студент, который пошагово воспроизводил методику одного химического эксперимента из учебника. Он старательно выполнил очередной шаг «добавьте азотную кислоту» и... в лаборатории прогремел взрыв! Когда впоследствии стали разбираться, в чём же дело, выяснилось, что на следующей странице учебника было написано: «... медленно, по каплям». Примечания и уточнения — очень важный элемент любого технического и научного текста. В любом документе фрагменты текста можно ранжировать по важности и критичности излагаемых сведений. Бывает просто обычный текст, который течёт себе ровно, как спокойная равнинная река. Бывают фрагменты с дополнительной, необязательной, уточняющей информацией: автору хотелось их добавить в текст, но они плохо укладываются в основную логику изложения материала. А ещё бывают критичные замечания и уточнения, которые обязательно должны быть обвешаны мигающими сигнальными огнями, сиренами, хлопушками и прочими средствами привлечения внимания читателя. Как же лучше оформлять примечания в технических текстах? В статье расскажу вам про пять несложных правил оформления примечаний и уточнений в технических текстах.

https://habr.com/ru/articles/822145/

#примечания #примечания_к_техническим_текстам #техническая_документация #примечания_к_документации #уточнения #правила_оформления_примечаний #технические_тексты #пользовательская_документация #светофор #технические_писатели

Почему светофор важнее Шекспира? Про примечания в технических текстах

У химиков есть известная байка, которую они любят рассказывать молодому поколению. Главный герой этой истории — студент, который пошагово воспроизводил методику одного химического эксперимента из учебника. Он старательно выполнил очередной шаг «добавьте азотную кислоту» и... в лаборатории прогремел взрыв! Когда впоследствии стали разбираться, в чём же дело, выяснилось, что на следующей странице учебника было написано: «... медленно, по каплям». Примечания и уточнения — очень важный элемент любого технического и научного текста. В любом документе фрагменты текста можно ранжировать по важности и критичности излагаемых сведений. Бывает просто обычный текст, который течёт себе ровно, как спокойная равнинная река. Бывают фрагменты с дополнительной, необязательной, уточняющей информацией: автору хотелось их добавить в текст, но они плохо укладываются в основную логику изложения материала. А ещё бывают критичные замечания и уточнения, которые обязательно должны быть обвешаны мигающими сигнальными огнями, сиренами, хлопушками и прочими средствами привлечения внимания читателя. Как же лучше оформлять примечания в технических текстах? В статье расскажу вам про пять несложных правил оформления примечаний и уточнений в технических текстах.

https://habr.com/ru/articles/822145/

#примечания #примечания_к_техническим_текстам #техническая_документация #примечания_к_документации #уточнения #правила_оформления_примечаний #технические_тексты #пользовательская_документация #светофор #технические_писатели

Почему светофор важнее Шекспира? Про примечания в технических текстах

У химиков есть известная байка, которую они любят рассказывать молодому поколению. Главный герой этой истории — студент, который пошагово воспроизводил методику одного химического эксперимента из учебника. Он старательно выполнил очередной шаг «добавьте азотную кислоту» и... в лаборатории прогремел взрыв! Когда впоследствии стали разбираться, в чём же дело, выяснилось, что на следующей странице учебника было написано: «... медленно, по каплям». Примечания и уточнения — очень важный элемент любого технического и научного текста. В любом документе фрагменты текста можно ранжировать по важности и критичности излагаемых сведений. Бывает просто обычный текст, который течёт себе ровно, как спокойная равнинная река. Бывают фрагменты с дополнительной, необязательной, уточняющей информацией: автору хотелось их добавить в текст, но они плохо укладываются в основную логику изложения материала. А ещё бывают критичные замечания и уточнения, которые обязательно должны быть обвешаны мигающими сигнальными огнями, сиренами, хлопушками и прочими средствами привлечения внимания читателя. Как же лучше оформлять примечания в технических текстах? В статье расскажу вам про пять несложных правил оформления примечаний и уточнений в технических текстах.

https://habr.com/ru/articles/822145/

#примечания #примечания_к_техническим_текстам #техническая_документация #примечания_к_документации #уточнения #правила_оформления_примечаний #технические_тексты #пользовательская_документация #светофор #технические_писатели

5 причин, почему пользователи терпеть ненавидят вашу документацию [и как это исправить]

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда. Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.

https://habr.com/ru/articles/811461/

#документация #документация_кода #документация_проекта #технические_писатели #документирование #пользовательская_документация #технология_единого_источника #проверка_документации #техническая_документация #обратная_связь

5 причин, почему пользователи терпеть ненавидят вашу документацию [и как это исправить]

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда. Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.

https://habr.com/ru/articles/811461/

#документация #документация_кода #документация_проекта #технические_писатели #документирование #пользовательская_документация #технология_единого_источника #проверка_документации #техническая_документация #обратная_связь

5 причин, почему пользователи терпеть ненавидят вашу документацию [и как это исправить]

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда. Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.

https://habr.com/ru/articles/811461/

#документация #документация_кода #документация_проекта #технические_писатели #документирование #пользовательская_документация #технология_единого_источника #проверка_документации #техническая_документация #обратная_связь