Рубрика «документация» - 3
Obsidian для профессионалов: рабочая система заметок на стыке подходов
2025-05-20 в 11:16, admin, рубрики: iso 27001, ITIL, obsidian, zettelkasten, документация, метаданные, организация знаний, шаблоны, эффективность
Как QA не утонуть в новом проекте. Часть 2: организация тестирования и документация
2025-05-12 в 11:05, admin, рубрики: chatgpt, qa, qa management, qa testing, документация, тестирование, тестовая документацияВ первой части (eсли не читали — вот она) я говорила о том, как быстро изучить проект, получить доступы и изучить документацию. Теперь переходим к следующему этапу — организации тестирования.
Порой всего просто слишком много и это вызывает хаос, в котором из вида теряются важные детали и появляется прокрастинация. Такие ситуации часто вызывают стресс и для того, чтобы этого избежать (или свести к минимуму) нужен план и понимание что, а главное для чего, нужно делать.
Текст без опечаток в документации и не только: внедряем CSpell
2025-04-18 в 18:00, admin, рубрики: cspell, docsascode, документация, орфография, спеллчекер, текстМеня зовут Саша, я технический писатель в команде документации Yandex Cloud. В свободное от работы время я занимаюсь другой работой — изучаю инструменты для документирования и экспериментирую с ними. Один из моих экспериментов был посвящен изучению и внедрению спеллчекера CSpell в мои процессы создания документации.
Статья будет полезна всем, кто хочет научиться проверять тексты в исходных файлах, будь то Markdown, YAML или комментарии в коде. Больше всего пользы из нее вынесут технические писатели и те, кто формирует процессы для команд технических писателей.
«Клюква» — автоматизация документации проектов на Python
2025-04-07 в 6:16, admin, рубрики: AI Assistant, AST, LangChain, llm, pycharm, python, UML, документация
Привет!
Меня зовут Алексей Фоменко.
Я разработчик из Нижнего Новгорода.
Сегодня хочу рассказать вам о своем сервисе "Клюква".
Почему "Клюква" и "автоматизация документации"?
Ответ на самом деле простой — потому что мне это название нравится.
AI в работе технического писателя
2025-04-03 в 4:15, admin, рубрики: AI, chatgpt, restructuredtext, sphinx, sphinx docs, автоматизация, документация, искусственный интеллект, рабочие процессы, технический писательВсем привет! Меня зовут Севара Ахтямова и я работаю техническим писателем — аналитиком около 4 лет. В этой статье я расскажу, как AI помог мне справиться с рабочей рутиной — от генерации toctree до отладки сборки Sphinx-документации. Всё это — на реальных задачах. Я постаралась собрать побольше примеров из личного опыта. Надеюсь, не слишком много.
Большие языковые модели как инструмент для анализа технической документации и решения ИТ-инцидентов
2025-03-27 в 21:19, admin, рубрики: chatgpt, llm, документация, инцидент, машинное обучение, нейросетьЛюбой инженер, сталкивавшийся с инцидентами в ИТ-системах, знает: решение часто есть в документации. Проблема в том, что найти его — как искать иголку в стоге сена. Документация объёмная, разрозненная, специфичная и написана далеко не всегда для людей. Время идёт, SLA поджимает.
Но что если бы у нас был помощник, который мгновенно читал бы всю документацию, понимал бы контекст сбоя и предлагал конкретные рекомендации? Сегодня это возможно — благодаря большим языковым моделям (LLM), таким как GPT-4, Claude, Gemini и другим.
Что такое правильная документация проекта
2025-02-06 в 8:16, admin, рубрики: bpmn, UML, архитектура приложений, архитектура систем, архитектура системы, документация, документация проекта, документирование проектов, системная аналитика, системная архитектураДокументация на личном опыте: диаграммы и документы, чтобы не нужно было лазить в код
Привет, меня зовут Михаил Пискунов, и я уже более 15 лет работаю в области разработки проектов и системной аналитики.
Унификация терминологии в документации: ключ к точности и удобству для пользователей
2025-02-05 в 11:53, admin, рубрики: автоматизация, документация, ИИ, техническая документация, технологии, унификацияДавайте обсудим, почему унификация терминологии — это не просто формальность, а важнейший инструмент для улучшения восприятия контента. Мы рассмотрим, как единообразие терминов влияет на восприятие и понимание информации, а также какие современные инструменты и практики помогают создать четкую и согласованную понятийную систему.
