Пишем пользовательскую документацию к медицинскому программному обеспечению правильно

Автор: Mega
Просмотров: 992
Комментариев:
Категория: Медицина
Дата: 19-04-2016, 19:33
Пишем пользовательскую документацию к медицинскому программному обеспечению правильно

К документации для медицинского программного обеспечения предъявляются особые требования. Точность формулировок, ясность изложения и грамотное структурирование информации играет огромную роль. Цена ошибки слишком высока. Неправильная интерпретация может отразиться на эффективности лечения или его своевременности.Пишем пользовательскую документацию к медицинскому программному обеспечению правильноПишем пользовательскую документацию к медицинскому программному обеспечению правильно

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

1. Точность терминологии

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

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

При разработке документации предпочтение нужно отдать тем инструментам, которые допускают совместную разработку. В этом случае и разработчики ПО, и врачи смогут одновременно получать доступ к тексту документации и оперативно вносить взаимные коррекции.

2. Доступность языка

Факт того, что программное обеспечение будет использоваться самыми разными представителями медицины, накладывает ограничения и на язык, которым написан текст руководства пользователя. Не допускается наличие жаргонизмов и сленга. Документация должна быть написана максимально просто и доступно.

Следует продумать структуру документации и привести ее в соответствие с фактической структурой программного обеспечения. Медицинское ПО часто используется в стрессовых ситуациях, и любые сложности с поиском нужного раздела могут вылиться в напрасно потерянные минуты. С той же целью при написании следует использовать простой и точный директивный язык.

Многие средства разработки документации, например, Dr.Explain, позволяют автоматически синхронизировать интерфейс программы с его документальным описанием. Такой инструментарий позволяет избежать рассогласования в описании функций медицинского ПО в документации. Четкие наименования разделов тоже могут создаваться автоматически.

3. Высокая степень визуализации

Как уже отмечено, эксплуатация медицинского ПО идет в условиях высокой срочности и высокого стресса пользователей (врачей, медицинских сестер). Читать длинные тексты, написанные формальным языком, банально нет времени.

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

Ускорить разработку пользовательской документации можно применением инструментов с автоматическим созданием снимков экрана и аннотаций к ним.

4. Единство стиля

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

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

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

Заключение

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

Научно-популярное онлайн издание "Меганаука"