#техпис — Public Fediverse posts

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Генеральная уборка базы знаний: плюсы, подводные камни, минусов не будет

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

https://habr.com/ru/companies/kaspersky/articles/968582/

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

Как документировать GraphQL API: полное руководство для технических писателей

GraphQL API — это мощно, но как его документировать, чтобы разработчики остались довольны? В этой статье — готовый план действий. Мы начнём со сравнения GraphQL и REST, затем покажем, как с помощью комментариев и примеров кода превратить схему в наглядное руководство. Вы узнаете, как улучшить GraphiQL Playground подсветкой синтаксиса и создать статический справочник, если Playground недоступен. В конце вас ждёт учебный репозиторий для тренировок на реальном API.

https://habr.com/ru/companies/flant/articles/971198/

#graphql #техническая_документация #техпис #graphql_api #playground #документирование #документирование_проектов #rest #rest_api #api

125 лет без багов: Разбираем матрешку как идеальный IT-продукт

24 октября русской матрешке исполняется 125 лет. Давайте отбросим сувенирный флер и посмотрим на этот артефакт глазами айтишников. Что увидели разработчик, тестировщик, DevOps, продакт и техпис? Спойлер: это шедевр инженерной мысли. Вперед к разбору

https://habr.com/ru/companies/astralinux/articles/959810/

#итпродукт #devops #itюмор #матрешка #техпис #тестирование #итпроект

125 лет без багов: Разбираем матрешку как идеальный IT-продукт

24 октября русской матрешке исполняется 125 лет. Давайте отбросим сувенирный флер и посмотрим на этот артефакт глазами айтишников. Что увидели разработчик, тестировщик, DevOps, продакт и техпис? Спойлер: это шедевр инженерной мысли. Вперед к разбору

https://habr.com/ru/companies/astralinux/articles/959810/

#итпродукт #devops #itюмор #матрешка #техпис #тестирование #итпроект

125 лет без багов: Разбираем матрешку как идеальный IT-продукт

24 октября русской матрешке исполняется 125 лет. Давайте отбросим сувенирный флер и посмотрим на этот артефакт глазами айтишников. Что увидели разработчик, тестировщик, DevOps, продакт и техпис? Спойлер: это шедевр инженерной мысли. Вперед к разбору

https://habr.com/ru/companies/astralinux/articles/959810/

#итпродукт #devops #itюмор #матрешка #техпис #тестирование #итпроект

125 лет без багов: Разбираем матрешку как идеальный IT-продукт

24 октября русской матрешке исполняется 125 лет. Давайте отбросим сувенирный флер и посмотрим на этот артефакт глазами айтишников. Что увидели разработчик, тестировщик, DevOps, продакт и техпис? Спойлер: это шедевр инженерной мысли. Вперед к разбору

https://habr.com/ru/companies/astralinux/articles/959810/

#итпродукт #devops #itюмор #матрешка #техпис #тестирование #итпроект

[Перевод] Как написать грамотный гайд: правила для техписов и разрабов

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

https://habr.com/ru/companies/netologyru/articles/873674/

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