-
09.11.2024Тестирование документации
Качественная документация играет важную роль в успехе продукта, но как убедиться, что она действительно работает? В докладе разберём понятие тестирование документации, его цели и задачи.
Тестирование документации — дополнительный этап обеспечения качества пользовательской документации, необходимый для проверки её функциональности и практической применимости.
Основная цель тестирования пользовательской документации — обеспечить читателю достоверность, актуальность и точность инструкций в части описания:- сценариев использования ПО, в том числе нелинейных и негативных;
- элементов интерфейса и реакций на действия пользователя;
- потенциальных ошибок и порядка их устранения.
Вы узнаете, когда и почему важно проводить тестирование документации, в том числе регрессионное тестирование документации, позволяющее выявить и исправить ошибки, возникающие при обновлениях продукта.Доклад полезен всем, кто стремится создавать не просто корректную, но и практически применимую документацию.-
Просто
-
20 мин
-
TechWriter Days / 2
-
04.02.2024Pro Качество документацииКак писать качественную документацию?За качество документов отвечают не только технические писатели. Это вопрос документационной культуры компании в целом.Доклад посвящен вопросам развития такой культуры и повышению качества всего процесса документирования.Я расскажу:
- об инструментах и подходах,
- как повысить значимость документации в компании,
- что делать, если нужно качественно и быстро.
-
Просто
-
20 мин
-
TechWriter Days / 1
-
23.08.2023Секреты документирования без готового продукта
Обсудим возможность документирования ПО или Систем без готового продукта. Как построить эффективный процесс документирования в условиях ограниченного времени и отсутствия конечного продукта.
Рассмотрим следующие ключевые аспекты, которые позволяют создавать качественные документы, даже когда основной продукт еще не готов:
- Сроки горят, а продукта еще нет?
- Включаем воображение - пишем, как должно быть и как будет.
- Ответственный за реализацию.
- Руководства без скриншотов.
- Руководства по макетам из Figma.
- Настройка процессов.
-
Просто
-
20 мин
-
Analyst Days / 17
-
23.08.2023Документация по ГОСТ: проклятие или спасение
Поговорим об использовании ГОСТ (Государственный Общероссийский Стандарт) в документировании проектов. Бытует мнение, что документация по ГОСТ - это сложно, скучно, “много буков”, никому не нужно и т.д. Но… Сфокусируемся на положительных моментах применения ГОСТ в IT-проектах и обсудим следующие аспекты:
- ГОСТ 19 и 34
- Специфика ГОСТовых проектов (“разовые”, ТЗ, приемка, сроки и пр.)
- Особенности ГОСТовой документации (структура, стиль изложения и пр.)
- Соблюдение сроков - наиважнейший приоритет
- Оформление
-
Среднe
-
40 мин
-
Analyst Days / 17