Обновить
16.09

Подготовка технической документации *

Всё о деятельности технических писателей

Сначала показывать
Порог рейтинга
Уровень сложности

Метаморфозы сознания. Про ревью и комментарии в технической документации

Время на прочтение9 мин
Количество просмотров4.5K

Привет! Меня зовут Дмитрий Миронюк, я старший технический писатель в компании Bercut. До этого работал системным администратором, специалистом внедрения и поддержки, программировал IP-телефонию, успел поработать тимлидом. Но как в итоге стал техническим писателем расскажу в другой раз. Сегодня поговорим о ревью и комментариях. Приведу реальные примеры из личного опыта, а также поделюсь наблюдениями, как процесс ревью повлиял на мое сознание.

Читать далее

«Чем занимается ваша команда?», или как дайджесты могут решать командные проблемы на примере технических писателей

Уровень сложностиПростой
Время на прочтение7 мин
Количество просмотров1.8K

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

Читать далее

Открытый смысл скрытого текста для разработчиков документации

Уровень сложностиПростой
Время на прочтение5 мин
Количество просмотров3.4K

— Видишь суслика?

— Нет…

 — И я не вижу. А он есть!

Одним из мощных и удобных инструментов текстовых редакторов является скрытый текст. Этот инструмент имеется практически во всех редакторах. Самым популярным и совершенным редактором на данный момент является MS Word. Поэтому некоторые возможности скрытого текста рассмотрены на его примере.

Читать далее

Пользовательская документация как путеводитель по продукту

Уровень сложностиПростой
Время на прочтение7 мин
Количество просмотров2.5K

Всем привет! Меня зовут Ксения Непомнящая, я — технический писатель в команде Zyfra Mass & Energy Balance (Z-MEB) компании «Цифровая индустриальная платформа». Z-MEB — это продукт для предприятий добычи и переработки нефти, газа и руды, участвующий в программе импортозамещения. Сегодня предлагаю вам взглянуть на пользовательскую документацию как на путеводитель по продукту и рассмотреть ее роль в увеличении ценности продукта.

Понятный интерфейс как город с понятной планировкой и развитой инфраструктурой

Представим себе город с понятной планировкой и развитой инфраструктурой и рассмотрим два варианта взаимодействия с ним.

Читать далее

Как язык моделирования ArchiMate помогает IT аналитикам в решении их задач

Уровень сложностиПростой
Время на прочтение4 мин
Количество просмотров6.4K

В постоянно меняющемся мире бизнеса и технологий организации сталкиваются с вызовом управления сложностью, стремясь при этом к эффективности и инновациям. Для решения этой проблемы аналитики начинают обращать свой взгляд к надежным языкам моделирования, чтобы получить всестороннее понимание архитектуры предприятия. ArchiMate, широко принятый и стандартизированный язык моделирования, становится мощным инструментом для аналитиков, обеспечивая структурированный подход к архитектуре предприятия, который улучшает принятие решений и стратегическое планирование.

ArchiMate предоставляет общий и унифицированный способ изображения и анализа архитектур предприятий. Разработанный The Open Group, этот открытый и независимый язык моделирования предлагает визуальное представление отношений между различными компонентами в организации. Язык разработан интуитивно, что делает его доступным как для технических, так и для неспециалистов. Нотация ArchiMate основана на последовательной структуре, что позволяет аналитикам создавать ясные, краткие и стандартизированные модели.

Читать далее

Написание документа «Общее описание системы» по ГОСТ 34

Время на прочтение4 мин
Количество просмотров11K

Всем привет! Меня зовут Мишинёва Екатерина, я – ведущий технический писатель с опытом работы в сфере IT более 10 лет.

Сегодня разговор пойдет про документ "Общее описание системы".

Читать далее

Техническое задание: как и зачем его писать, и почему без него не обойтись

Уровень сложностиПростой
Время на прочтение10 мин
Количество просмотров23K

Все удачные IT-продукты были когда-то просто идеями. И очень часто (почти всегда) идеи принадлежат людям, далеким от разработки программного и аппаратного обеспечения.

Они хотят что-то улучшить в своем бизнесе, в том направлении деятельности, которое знают досконально. Идеи, мысли, мечты – это прекрасно, но важно, чтобы специалист верно их понял и воплотил в работающее устройство или программу.

Правильно довести идею до разработки поможет техническое задание. Зачем готовить ТЗ, кто и как должен это делать, можно ли обойтись без ТЗ и как минимизировать расходы – обо всем этом вы узнаете из данной статьи.

Читать далее

От бизнес-идеи к техническому заданию. Список необходимой информации

Время на прочтение7 мин
Количество просмотров2.1K

Воплотить свою бизнес-идею при помощи IT-технологий вполне реально и я видела подобное не раз. В этой статье мы составим и подробно разберем список необходимой информации для перевода бизнес-идеи в техзадание. Основан материал на моем опыте работы в компании мобильной разработки. Это даст начинающим предпринимателям и менеджерам IT-проектов понимание, как верно сделать первый шаг и заложить фундамент будущего проекта.

Кому будет полезна эта статья:

1. Тем, кто начинает свой путь в IT-предпринимательстве, но не знаком с технической стороной вопроса.

2. Начинающим менеджерам IT-проектов, которые пока не имеют опыта в постановке задач подрядчикам.

3. Владельцам уже существующих проектов, которые нуждаются в дополнениях/доработках.

Читать далее

«Кто на ком стоял?» Про страдательный залог в технической документации

Время на прочтение5 мин
Количество просмотров19K

В технической документации часто встречаются фразы с использованием страдательного залога. Параметры там «задаются», файлы «сохраняются», а программа «запускается». Ох, опасная эта форма для строгих и однозначных описаний! Почему же страдательный залог заставляет читателей страдать? Будем разбираться...

Читать далее

Написание Частного технического задания (ЧТЗ)

Уровень сложностиСредний
Время на прочтение6 мин
Количество просмотров34K

Всем привет! Меня зовут Мишинёва Екатерина, я – ведущий технический писатель с опытом работы в сфере IT более 10 лет.

Рассмотрим подробнее.

Читать далее

Проектирование архитектуры через User Stories, часть 1. Вовлекаем в процесс заказчика

Уровень сложностиСредний
Время на прочтение8 мин
Количество просмотров8.7K

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

Читать далее

Зачем и как планировать трудозатраты технического писателя?

Уровень сложностиПростой
Время на прочтение7 мин
Количество просмотров3.7K

Меня зовут Юлия Седова, и я представляю команду технических писателей ГК «Цифра». В рамках масштабной работы по повышению качества документации мы столкнулись с проблемой отсутствия культуры предварительного планирования трудозатрат технического писателя. В этой статье я хочу поделиться нашим решением проблемы.

Как мы решали проблему планирования?

Проектирование интеграции. Чек-лист — как подготовить архитектурное решение

Уровень сложностиПростой
Время на прочтение4 мин
Количество просмотров17K

В работе solution архитектора или системного аналитика есть задачи на проектирование интеграции. Иногда заказчик приносит задачу с требованиями на один абзац.

С чего же начать, если перед вами такие минимальные бизнес требования?

Хочу узнать

Ближайшие события

Как выжать максимум из Confluence. Глава первая

Уровень сложностиПростой
Время на прочтение10 мин
Количество просмотров71K

Привет, Хабр! Я Ульяна, старший аналитик в направлении продуктового и системного анализа в отделе Tinkoff Mobile Core. Наш отдел разрабатывает общие технические решения — библиотеки, которые используются в мобильных приложениях экосистемы Тинькофф.

Для наших коллег мы проектируем документацию и инструкции для разрабатываемых библиотек, различных общих проектов и исследований. Вот главные требования к документации: она должна быть максимально понятной и структурированной, а поиск — легким и быстрым.

Документацию мы ведем в Confluence — и обычно, когда я рассказываю про Confluence, у многих он вызывает, мягко говоря, неприятные ассоциации. Миллион разделов, неудобная навигация, портянки бесконечного текста и многое другое, что отбивает желание даже открывать любую wiki. Но я спешу вас обрадовать — все может быть совсем иначе!

Расскажу, как выжать максимум из Confluence, чтобы вы могли научиться использовать макросы и другие его возможности и с помощью них быстро проектировать понятную и удобную документацию.

Читать далее

Шаблон Технического задания по ГОСТ 34

Уровень сложностиСредний
Время на прочтение2 мин
Количество просмотров26K

Всем привет! Меня зовут Мишинёва Екатерина, я – ведущий технический писатель с опытом работы в сфере IT более 10 лет.

Поговорим о структуре Технического задания.

Читать далее

Экспорт статьи из LibreOffice Writer в Habr Flavored Markdown или HTML

Уровень сложностиПростой
Время на прочтение8 мин
Количество просмотров2.7K

Резюме.
В статье дается ссылка на файл в формате ODT (основной формат файлов, используемый в текстовом редакторе LibreOffice Writer), содержащий макросы на «родном» для LibreOffice языке программирования макросов BASIC, которые осуществляют экспорт текста из LibreOffice Writer в новый файл в формате Habr Flavored Markdown (далее - HFM) или HTML, в виде, пригодном для размещения статьи в интернете, например, на сайте habr.com.

Текст данной статьи был экспортирован в формат HFM для размещения на сайте habr.com с помощью библиотеки макросов, содержащихся в данном файле.

Для использования достаточно скачать указанный файл (его можно переименовать), заменить в нем текст на свой текст, подготовленный в соответствии с описанием в статье, и вызвать макрос. В папке со скачанным файлом появится новый файл в выбранном формате.

Рассмотрение макросов на языке BASIC, которые осуществляют экспорт, предполагается в отдельной статье.

Читать далее

Как получить оффер на 180к с помощью ChatGPT?

Уровень сложностиПростой
Время на прочтение7 мин
Количество просмотров41K

Сегодня я хочу поделиться историей о том, как я помог бывшему коллеге получить оффер на позицию ведущего бизнес-аналитика с помощью ChatGPT

Читать далее

Упорядочиваем архитектуру Банка

Уровень сложностиСредний
Время на прочтение13 мин
Количество просмотров6.6K

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

Бизнес хочет простых вещей: простого и быстрого масштабирования, гибкости для адаптации решения, и чтобы всё было просто для клиента.

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

 надежность и доступность сервисов банка;

 прозрачность информационного ландшафта для аудита;

повышенные требования к финансовой и информационной безопасности;

 соответствие требованиям к ИТ инфраструктуре со стороны ЦБ РФ.

Все это приводит к тому, что изменения ИТ ландшафта предприятия проводятся под пристальным наблюдением огромного количества заинтересованных лиц и подразделений.

У этой статьи два автора: Борис Пишванов — начальник управления Solution архитектуры и Михаил Салахов — архитектор направления Альфа-Банка. Мы расскажем, что делаем, чтобы архитектурный ландшафт Альфа-Банка стал прозрачным и простым для понимания огромного количества заинтересованных лиц. Обратите внимание на статью, если думали над тем как, систематизировать и упорядочить архитектуру большого предприятия.

Читать далее

Способы автоматизации процессов по написанию документации для технических писателей

Уровень сложностиСредний
Время на прочтение6 мин
Количество просмотров9.7K

Всем привет! Меня зовут Екатерина Мишинёва, я ведущий технический писатель с опытом работы в IT-компаниях более 10 лет.

Рано или поздно в компаниях приходят к автоматизации различных процессов. Без технического писателя не обойтись, но для ускорения процесса, упрощения выполнения задач и систематизации – встает вопрос перед выбором способов автоматизации процессов по написанию технической документации.

Читать далее

Создание системы документирования, или как в Cloud.ru от «ворда» к docs as code за месяц переходили. Часть 2

Время на прочтение13 мин
Количество просмотров6.7K

Привет, Хабр! На связи снова Юрий Никулин. В первой части статьи я рассказывал, почему в Cloud.ru решили перейти на doc as code и какой технологический стек мы выбрали. В этой части поделюсь самим процессом — расскажу, как настраивали, тестировали и внедряли новую систему и что из этого вышло.

Читать дальше