Всё о деятельности технических писателей
Главная цель любой инструкции — дать ответ на вопрос читателя. Инструкция не выполняет свою функцию, если читатель не смог быстро найти нужную ему информацию. Поэтому написать текст инструкции мало — нужно ещё и оформить его так, чтобы помочь пользователю в его нелёгкой задаче. Для этого можно использовать ряд универсальных приёмов.
Альтернативная нотация описания функциональной архитектуры и архитектуры интеграций для решения задач ИТ-развития в рамках проектных задач, продуктового развития и инициатив бизнеса для командной работы в едином информационном поле бизнес и системных аналитиков, архитекторов, разработчиков, тестировщиков и специалистов поддержки.
База знаний помогает пользователям быстро понять, какие возможности есть у облачных сервисов — так же, как качественный README объясняет назначение open source‑проекта.
В этом материале мы собрали несколько интересных бесплатных инструментов для подготовки README.
Каждый разработчик рано или поздно сталкивается с ситуацией: из команды уходит «тот самый» человек, который держал в голове половину архитектуры. Вместе с ним уходит не только опыт, но и часть будущего проекта. В статье делюсь мыслями и подходами, как минимизировать потери при передаче знаний, какие форматы работают, а какие — нет, и почему документация должна быть живой, а не мёртвым архивом на Wiki.
НИИ ПТЭС — один из лидеров российского строительного рынка — как и многие отечественные предприятия столкнулся с необходимостью импортозамещения. Маркетолог компании Евгений Платонов рассказывает, почему инженеры выбрали именно nanoCAD и как был организован путь от тестового периода до успешного внедрения новой САПР в бизнес-процессы.
Я учусь на факультете, который продает студентов в компании партнеры. После окончания второго курса все обязаны пойти на круглогодичную стажировку. Я прошел десяток собеседований на позицию стажера системного аналитика, а через полгода уже сам проводил собеседование.
В статье пытаемся разобраться какой ключевой навык аналитика и как его можно проверять на собеседовании...
Приглашаем на премьеру TDMS Фарватер Web — новой системы с удобным веб‑интерфейсом для документооборота и управления проектированием в строительстве.
Дата и формат: 30 сентября в 11:00 (МСК), онлайн, бесплатно
Потерянные версии документов, поиски актуальных планов и отчетов, несоответствие статус проекта и реального состояния... Такое знакомо многим и менеджерам проектов, и спонсорам, и командам (которые считают, что проще написать заново). Дело не в плохих людях, а в отсутствии системы, которая учитывает статусы и этапы проектов.
С проблемой терминологии сталкивается каждый технический писатель. Многие ИТ-термины заимствованы из английского языка и имеют несколько вариантов перевода, или не переводятся вовсе. Для создания терминологии необходимо проанализировать существующие термины и их использование, выбрать единый стандарт написания и сделать термины понятными для всех членов команды.
Мы — команда документирования платформы Platform V в СберТехе: Лидия Ковач, middle технический писатель, Мария Бурханова, senior технический писатель, и Светлана Каюшина, руководитель команды. Хотим рассказать, как мы разработали глоссарий, который повысил качество документации нашей цифровой платформы для построения ИТ‑ландшафта.
Поделимся тем, как устроен наш глоссарий, с какими трудностями мы столкнулись и какими инструментами пользовались. Надеемся, это поможет вам добиться точности и единообразия терминологии в вашей компании.
Сегодня расскажем, как инженеры центра «ПрофИнформЗащита» внедрили nanoCAD BIM ОПС и смогли существенно сократить сроки подготовки проектной документации на примере реальных кейсов.
Всем привет, меня зовут Максим, я QA-специалист в компании SimbirSoft. Более двух лет я занимаюсь обеспечением качества, за это время мне часто попадались проекты с отсутствующей или устаревшей технической документацией. Как быть в подобной ситуации и при этом сохранить нервные клетки, я расскажу в этой статье.
Бывают ситуации, когда тестировать приходится вопреки. Вопреки срокам, здравому смыслу или отсутствию требований. Именно последний кейс мы и разберем с вами сегодня 🦾
Пока разработчики по всему миру мучаются с ChatGPT, пытаясь выжать из него хоть что-то приличное для технической документации, команда Artezio пошла другим путем. Вместо того, чтобы полагаться на сырой ИИ, мы создали «Кентавр» — гибридную систему, которая объединяет возможности больших языковых моделей с экспертизой опытных аналитиков.
В результате то, на что enterprise-команды тратят месяц (на подготовку полного пакета требований на 60-100 страниц), задействуя несколько специалистов, «Кентавр» делает за пару дней силами одного аналитика. При этом документы качественнее: структурированные, непротиворечивые и главное — повторяемые от проекта к проекту.
О том, как создавалась эта система, с какими проблемами столкнулись разработчики и почему простого ChatGPT недостаточно для серьезной документации, рассказали Андрей Шагалов, директор по маркетингу Artezio, и Денис Харченко, директор по развитию бизнеса компании. Они поделились техническими деталями архитектуры, объяснили концепцию Human-in-the-Loop и раскрыли планы по превращению нового инструмента в популярный коммерческий продукт.
Технический писатель — своего рода проводник между разработчиками и пользователями. Мы берём техзадания, обрывочные комментарии, макеты, проходим процессы в продукте и создаем понятные инструкции. Часто на стадии подготовки возникают вопросы: «Где искать информацию — и какую?»
В некоторых командах проблема решается с помощью продактов, тимлида или автоматизации распределения задач. Однако так бывает далеко не всегда, и ответы могут найтись не сразу, особенно при высокой загруженности и в хаосе задач. Неожиданно, простая подсказка пришла из мира аниме: в сериале Mononoke (не путать с Принцессой Мононоке) персонаж по имени Аптекарь изгоняет злых духов, используя метод: «форма, суть, причина». Если не смотрели — не беда, в первую очередь мы говорим о структурированном подходе к поиску информации.
Меня зовут Александр Панов, я занимаюсь разработкой документации в Test IT и расскажу, как подход из аниме помогает структурировать работу и создавать понятные доки. Мы обсудим методологические аспекты и рассмотрим практический пример. В конце статьи вы найдете небольшой чеклист, где все данные сведены в таблицу.
В предыдущей статье мы рассмотрели, как система Документы способствует выстраиванию процесса управления документацией в административно-хозяйственном отделе (АХО). На этот раз мы рассмотрим отдел кадров.
Это короткий пост, вдохновлённый карточками по теме, которые я встретил на канале S0ER'а. В геймдеве такая практика встречается нечасто. Поэтому внесу дополнительное упоминание в ленту. Оставлю вводные, ссылки на более подробное изучение, поделюсь своим опытом и расскажу, какое отношение к этому имеет AI.
Привет, Хабр! Меня зовут Мария Бурханова, я технический писатель, старший руководитель ИТ-направления документирования Platform V в СберТехе. На TechWriter Days я рассказывала, как техническому писателю научиться читать и понимать сложные нотации, чтобы сделать документацию простой и понятной.
Сегодня хочу рассказать, зачем техпису нужны нотации и почему их так много, какие знания о нотациях точно пригодятся и как применить эти знания на практике.
Статья будет полезна техническим писателям, аналитикам, разработчикам и всем интересующимся этой темой. Вы научитесь читать диаграммы и схемы в разных нотациях и эффективно использовать их для создания понятной и структурированной документации.
Diplodoc - платформа для создания технической документации в концепции Docs as Сode с открытым исходным кодом.
С помощью Diplodoc можно создавать документы любой сложности, быстро валидировать их и выкладывать в общий доступ, а также настраивать интеграцию с системами автоматической документации. Именно на этой технологии построена документация сервисов Яндекс.
В данной статье я расскажу, как создать базовый скелет документации на примере собственного многостраничного лендинга.
Всем привет! Решил я тут собрать в кучу все свои знания по онбордингу новых сотрудников поддержки. За свою карьеру я построил несколько отделов саппорта с нуля и, признаться, порядком устал от бездушных корпоративных регламентов, от которых клонит в сон уже на третьей странице. Писать очередной талмуд «делай хорошо — не делай плохо», который никто не дочитает, — гиблое дело, особенно для молодого поколения, выросшего в эпоху TikTok.
В организациях зачастую можно наблюдать картину, когда разные отделы используют разные системы создания и ведения документации. Это ведет к нескольким проблемам:
• Отсутствие контроля структуры и содержания документа.
• Проблема совместимости файлов и форматов.
• Отсутствие единого хранилища и версионированию.
• Замедление согласования из‑за отсутствия интеграции с системами электронного — документооборота.
• Дублирование документов.
• Сложность с отчетностью и аудиторскими проверками — документы, в т.ч. архивные, не хранятся централизованно.
• Дополнительные затраты для обучения персонала и поддержке нескольких систем.
Как можно решить всю совокупность этих проблем? Лучшим вариантом является гибкая система документооборота с возможностью согласования документов прямо в системе, единым хранилищем документов (в том числе архивных) и возможностью отслеживания версий документов, которая может быть использована во всех отделах компании, чтобы не увеличивать количество используемых инструментов и затраты на поддержку систем в компании. И на рынке есть система, удовлетворяющая всем этим запросам — это Сфера.Документы.
Рассмотрим конкретный бизнес‑сценарий, когда административно‑хозяйственному отделу (АХО) нужно закупить мелкое оборудование для ремонта офиса.
Рассказываем о возможностях nanoCAD BIM Строительство для проектирования мостов и линейных сооружений, включая создание параметрических объектов, работу с библиотеками и интеграцию с другими BIM-решениями. На примере обучения сотрудников «Института Стройпроект» показано, как инструменты программы позволяют эффективно моделировать сложные конструкции, автоматизировать процессы и адаптировать решения под конкретные проектные задачи.