As inovações no domínio dos dispositivos médicos multiplicaram-se nos últimos anos. Esta aceleração pode ser atribuída, em especial, ao vasto desenvolvimento da computação em nuvem e da Internet das Coisas (IoT). Da mesma forma, o «Software como Dispositivo Médico» (SaMD) tem registado um aumento da procura e continua a ser um dos principais motores do crescimento global da indústria de dispositivos médicos.
No âmbito dos cuidados de saúde, o software de diagnóstico ( SaMD ) constitui, em particular, uma nova categoria de recurso de software com uma função especializada. De acordo com o Fórum Internacional de Reguladores de Dispositivos Médicos (IMDRF), o software de diagnóstico é definido como«software destinado a ser utilizado para um ou mais fins médicos, que cumpre esses fins sem fazer parte de um dispositivo médico de hardware». ( SaMD )
Todos os produtos de desenvolvimento de software, quer sejam criados por uma equipa pequena ou por uma grande empresa, requerem documentação técnica para manter todas as partes interessadas em sintonia e facilitar a navegação por um percurso que, de outra forma, seria avassalador. Ao longo do ciclo de vida do desenvolvimento de software, são criados e mantidos vários documentos (SDLC).
A documentação fornece orientações às equipas de desenvolvimento, aos testadores, aos utilizadores e a todos os demais intervenientes no projeto, ajudando-os a atingir os seus objetivos. A conceção e o desenvolvimento destes documentos constituem um processo complexo que requer conhecimentos especializados em redação técnica.
A documentação para SaMD refere-se a guias do utilizador, manuais de operação, instruções de utilização (IFUs), tutoriais e outros materiais que descrevem o desenvolvimento, a funcionalidade e a utilização de um produto de software. A documentação está dividida nas seguintes categorias:
- Documentação do produto: Descreve o produto em desenvolvimento e fornece instruções para a execução de várias tarefas. A documentação do produto inclui, geralmente, requisitos, especificações técnicas, lógica de negócio e manuais. Existem dois (02) tipos principais de documentação do produto:
- Documentação do sistema: Trata-se de documentos que descrevem o sistema e as suas componentes. Inclui um documento de requisitos do produto, um documento de conceção, um protocolo de arquitetura, o código-fonte do programa e as perguntas frequentes (FAQ).
- Documentação do utilizador: Abrange manuais elaborados principalmente para os utilizadores finais do produto e para os administradores de sistema. A documentação do utilizador inclui tutoriais, guias do utilizador, manuais de resolução de problemas, guias de instalação, instruções de utilização (IFU) e manuais de referência.
- Documentação do processo: Representa todos os documentos produzidos durante o desenvolvimento e a manutenção que descrevem o processo. Exemplos comuns de documentos relacionados com o processo são guias padrão, documentação de projeto, como planos de projeto, calendários de testes, relatórios, atas de reuniões e até mesmo a correspondência comercial.
A principal diferença entre a documentação de processos e a documentação de produtos reside no facto de a primeira registar o processo de desenvolvimento e a segunda descrever o produto que está a ser desenvolvido. Enquanto a documentação de produtos se destina a públicos internos e externos, a documentação de processos destina-se principalmente às pessoas que estão a desenvolver o produto.
É certo que a criação de documentos para SaMD é complicada, uma vez que os fluxos de trabalho variam consoante a empresa e o dispositivo médico em questão. Sem nos aprofundarmos na utilização de modelos ou de quaisquer ferramentas de documentação, existem certas práticas recomendadas que, se seguidas, podem facilitar o processo de criação de documentos para SaMD. A seguir, enumeramos algumas dessas práticas recomendadas:
- Compreender o objetivo e o público-alvo do documento
- Anote as perguntas importantes
- Esboço da documentação técnica
- Reúna as informações necessárias
- Redigir rascunhos de documentação
- Aproveite os recursos visuais de uma boa documentação
- Efetuar a edição final
Não há segredos ocultos para um bom processo de documentação para SaMD. Isso consegue-se através de um planeamento abrangente. Não se trata de um esforço individual, mas requer uma colaboração estreita com as partes interessadas relevantes, os programadores de software e outras entidades direta ou indiretamente envolvidas no projeto. Seguir as melhores práticas, resolver uma lista de pontos críticos e, acima de tudo, manter-se dentro do âmbito do projeto ajudará a preparar uma documentação de excelência para SaMD.
Contacte um especialista em redação técnica para obter mais informações sobre a documentação do « SaMD » e as melhores práticas, e para que os Guias do Utilizador sejam redigidos e documentados.
