Всем привет! Меня зовут Севара Ахтямова и я работаю техническим писателем — аналитиком около 4 лет. В этой статье я расскажу, как AI помог мне справиться с рабочей рутиной — от генерации toctree до отладки сборки Sphinx-документации. Всё это — на реальных задачах. Я постаралась собрать побольше примеров из личного опыта. Надеюсь, не слишком много.
Рубрика «sphinx docs»
AI в работе технического писателя
2025-04-03 в 4:15, admin, рубрики: AI, chatgpt, restructuredtext, sphinx, sphinx docs, автоматизация, документация, искусственный интеллект, рабочие процессы, технический писательDocs as code против или вместе с Confluence? Обзор нескольких способов публикации из репозитория в Confluence
2020-01-15 в 13:59, admin, рубрики: atlassian, confluence, confluence api, docs as code, markdown, python, restructured text, rst, sphinx docs, wiki, документация, управление проектамиМногие уже давно или активно используют или смотрят в сторону модели хранения и публикации документации как кода, это значит применять к документации все те же правила, инструменты и процедуры, что и к программному коду, например, хранить в репозитории, прогонять тесты, собирать и релизить в CI/CD. Этот подход позволяет поддерживать документацию актуальной к коду, версионировать и отслеживать изменения, используя привычные инструменты разработки.
Однако в то же время во многих компаниях годами существуют также и вики-системы, в которых к документации получают доступ другие команды и сотрудники, например, менеджеры проектов. Что если вам захотелось привести хранение и публикацию к единому виду, то есть наряду с HTML публиковать доки и в Confluence? В этой статье я дам обзор решений задачи публикации документов из репозитория в Confluence.
Читать полностью »