Как организовать процесс работы с документацией процесс — упорядочивание и сохранение знаний команды выбор подходящего формата: Markdown, Wiki, Confluence, GitHub Pages разделение документов по типам: API,…
Как документировать API микросервисов с помощью Swagger/OpenAPI? — стандарт OpenAPI для описания REST API в формате YAML/JSON — интерактивная документация, создаваемая автоматически (Swagger UI) — валидация API и…
сфера: управление знаниями и разработка ПО основа: последовательная и понятная иерархия разделов начать с: оглавления, введения и описания целей документа далее: архитектура системы, инструкции по установке и…
Правила оформления баг-репортов Контекст: баг-репорт — это документ, предназначенный для учёта и отслеживания ошибок в ПО Кратко и однозначно описать проблему (что именно не работает) Привести шаги воспроизведения…
Правила оформления тест-кейсов однозначная и понятная структура (ID, название, описание, шаги, ожидаемый результат) понятные и конкретные формулировки для каждого шага единый формат и согласованная терминология…
цель — убедиться в полноте и понятности представленной информации изучаем материалы с позиции конечного пользователя или участника команды проверяем актуальность: исключаем устаревшие сведения и неработающие ссылки…
Ключевые виды проектной документации Техническая документация: спецификации, архитектура, API и схемы Пользовательская документация: инструкции, руководства и FAQ Проектная документация: требования, планы и дорожные…
Классификация требований в BABOK и Wiegers BABOK: распределение требований по типу и степени детализации К основным категориям BABOK относятся: Бизнес-требования — цели и ожидаемые выгоды Пользовательские требования —…
Основные задачи системного аналитика выявление и изучение требований бизнес-заказчика перевод требований в формальные спецификации построение моделей бизнес- и системных процессов согласование требований между…
Основные поля и атрибуты баг-репорта уникальный идентификатор (номер записи) заголовок (сжатая формулировка ошибки) описание (подробности и порядок воспроизведения) приоритет (срочность исправления) серьёзность…
Основные способы текстового документирования требований структурированные спецификации (SRS) — формальный документ, в котором подробно зафиксированы требования user stories — короткие формулировки функционала,…
требования — основа успешной реализации проекта Бизнес-требования определяют цели и задачи организации показывают ценность продукта и приоритеты бизнеса создают основу для выбора проектного решения Пользовательские…