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

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

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

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

Космотекст: отправляем статьи в космос — и объявляем победителей 🚀

Привет от Хабра! Несем вам буквально космическую новость — мы подвели итоги конкурса космических статей и выбрали те, что отправятся в настоящий КОСМОС 🛸 . А еще отобрали автора лучшей статьи за время существования Хабра, который забирает экскурсию на Байконур! Рассказываем, какие авторы стали космическими победителями и о чем они написали.

https://habr.com/ru/specials/968096/?utm_source=habrahabr&utm_medium=rss&utm_campaign=968096

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

Космотекст: отправляем статьи в космос — и объявляем победителей 🚀

Привет от Хабра! Несем вам буквально космическую новость — мы подвели итоги конкурса космических статей и выбрали те, что отправятся в настоящий КОСМОС 🛸 . А еще отобрали автора лучшей статьи за время существования Хабра, который забирает экскурсию на Байконур! Рассказываем, какие авторы стали космическими победителями и о чем они написали.

https://habr.com/ru/specials/968096/

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

Размышления о документации

Вряд ли найдётся кто-либо, кто в здравом уме и ясной памяти будет отрицать необходимость документации. Любой продукт имеет (или должен иметь) свою документацию. Как минимум – инструкцию о том, как этим продуктом пользоваться. Производители почти всегда указывают – « прежде чем начать пользоваться нашим продуктом, внимательно ознакомьтесь с инструкцией ». Но дело почти никогда не ограничивается инструкцией пользователя. Производители также составляют и другую документацию – техническую, эксплуатационную. Но ЧТО же должен создавать автор документации? Что должна в себя включать документация, когда, на каком этапе и в каком объёме она должна создаваться, ЧТО она должна содержать, когда, кому и при каких обстоятельствах она может потребоваться? В данной статье мы и поразмышляем об этом... Читать статью

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

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

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

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

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

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

Космотекст: запускаем лучшие статьи в космос

Привет, это Хабр с буквально космической новостью — у нас стартует конкурс по написанию статей, где 20 лучших мы отправим в... 🛸КОСМОС🛸. Да, прямо в космос-космос. Да, в самый настоящий! Мы делаем такое впервые, поэтому сами в большом предвкушении от процесса и результата. Как мы уже сказали, по итогам конкурса мы выберем 20 статей, а вместе с ними на орбиту улетит еще 60 лучших технических публикаций, которые авторы написали за все почти 20 лет существования Хабра. И для лучшего автора из этих 80 статей у нас с RUVDS есть ☄️ супер приз — экскурсия на Байконур☄️ . Сразу скажем, что участвовать могут только статьи от самостоятельных авторов, а не от компаний. Ну а остальные космические подробности космического конкурса рассказываем ниже. Читать про космотекст

https://habr.com/ru/specials/926358/

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

Космотекст: запускаем лучшие статьи в космос

Привет, это Хабр с буквально космической новостью — у нас стартует конкурс по написанию статей, где 20 лучших мы отправим в... 🛸КОСМОС🛸. Да, прямо в космос-космос. Да, в самый настоящий! Мы делаем такое впервые, поэтому сами в большом предвкушении от процесса и результата. Как мы уже сказали, по итогам конкурса мы выберем 20 статей, а вместе с ними на орбиту улетит еще 60 лучших технических публикаций, которые авторы написали за все почти 20 лет существования Хабра. И для лучшего автора из этих 80 статей у нас с RUVDS есть ☄️ супер приз — экскурсия на Байконур☄️ . Сразу скажем, что участвовать могут только статьи от самостоятельных авторов, а не от компаний. Ну а остальные космические подробности космического конкурса рассказываем ниже. Читать про космотекст

https://habr.com/ru/specials/926358/

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

Михаил Острогорский — о том, как в России появились технические писатели и как они создали свою профессию

Для меня, студента, а потом выпускника московского технического вуза по специальности «Прикладная математика», середина 1990-х годов выглядела дивным новым миром и взрывом возможностей. Появлялись новые российские компании, новые продукты, приходили в Россию иностранные компьютерные и софтверные компании. И всё это было окружено многочисленными выставками, всевозможными семинарами, презентациями, журналами и еженедельниками. «Войти в айти» тогда было сравнительно просто: бери и делай то, что можешь и умеешь или хочешь, хотя и не очень умеешь, но знаешь, что так бывает, и можешь убедить окружающих, что ты — как раз тот, кто так может. В начале 1990-х был такой еженедельник «Софт Маркет» — первое (по крайней мере, так говорят) специализированное компьютерное издание в России. Меня взяли туда внештатным корреспондентом. Я прислал им книгу своих стихов и предложение: давайте сделаем у вас новую рубрику, литературное творчество программистов, я буду ее вести. Они сказали: стихов не надо, а вот корреспондент нам сейчас нужен. Так я стал компьютерным журналистом. Но оказалось, что для журналиста я недостаточно язвителен, а для автора рекламных статей слишком правдив. Пришлось перейти к крупной форме. В одно прекрасное утро я выкинул со своего личного сайта всё, кроме объявления о том, что я готов писать техническую документацию. Дальше случилось удивительное: посыпались заказы. Оказалось, что это вообще кому-то нужно. Что я технический писатель, мне потом кто-то из этих заказчиков и рассказал.

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

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

AI в работе технического писателя

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

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

#ai #искусственный_интеллект #sphinx #документация #автоматизация #технический_писатель #рабочие_процессы #restructuredtext #chatgpt #sphinx_docs

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

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

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

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