Автоматизация оценки качества пользовательского контента, Татьяна Родионова, Positive Technologies, CEE-SECR 2017

В эру тотальной автоматизации настало время и для технических писателей поддержать тренд и автоматизировать самые утомительные задания в части контроля качества пользовательской документации. Мы расскажем и покажем, как это сделать средствами Schematron.

Доклад рассчитан на инженеров DevOps, разработчиков и контент-менеджеров, в задачи которых может входить автоматизация процессов контроля качества контента.

Transcript

1. ptsecurity.ru Автоматизация контроля качества пользовательского контента Никита Ковин Татьяна Родионова
2. ЗАЧЕМ тестировать контент
4. Контент, ориентированный на пользователя Соответствует запросу пользователя Просто найти ответ на вопрос Инструкции полные, ожидаемый результат
5. Последствия недостаточного контроля контента
6. ЧТО тестируем
7. Что контролировать Определите, кто хочет измерять качество и какие требования предъявляет к результатам, автоматизируйте получение профиля качества Составьте список проверок, автоматизируйте самые рутинные проверки Определите критерии качества Решите, каких целей должен достигать ваш контент, декомпозируйте цели на задачи • Соответствует целевой аудитории • Соответствует продукту • Снижает стоимость технической поддержки • …. • Соответствует целевой аудитории • Модульность исходя из задач пользователя • Языковая «чистота» • Покрытие основных use cases • Терминология • Верстка • Соглашения типизации контента (классы, модули) • Структурное документирование (на основе XML) • Стандарты и соглашения верстки • Терминологическая база • Типизация и уровни важности ошибок • Соответствует целевой аудитории • Модульность исходя из задач пользователя • Языковая «чистота» • Покрытие основных use cases • Терминология • Верстка • Профиль качества • Статистика по ошибкам: важность, тип ошибки • Вердикт по релизу контента
8. Критерии качества – основа для автоматизации • Требования к созданию контента: • Соглашения типизации контента (классы, модули) • Структурное документирование (на основе XML) • Стандарты и соглашения верстки • Терминологическая база • Типизация и уровни важности ошибок • Инструменты и спецификации: • Расширения и библиотеки для обработки XML (SimpleXML, XmlReader, libxlml2 и пр.)* • Schematron ISO: https://goo.gl/2wdLZi • XPath: https://www.w3.org/TR/xpath • XSLT: https://www.w3.org/TR/xslt * В презентации используется Python с lxml (http://lxml.de)
9. КАК автоматизируем тестирование
10. Пример документа
11. Пример документа
12. Структура проекта Контроль структуры Контроль терминологии Запуск автотестов Контроль структуры Создание профиля качества
13. Проверка Schematron
14. XSL-преобразования: генерация отчета
15. XSL-преобразования: генерация отчета
16. Спасибо за внимание! ptsecurity.ru