2 min ler
Nos últimos anos, as inovações no domínio dos dispositivos médicos registaram um aumento considerável. Esta aceleração pode ser especialmente atribuída ao vasto desenvolvimento da computação em nuvem e da Internet das Coisas (IoT). Do mesmo modo, o Software como Dispositivo Médico (SaMD) registou um aumento da procura e continua a ser um dos principais contribuintes para o crescimento global da indústria dos dispositivos.
No domínio dos cuidados de saúde, o SaMD é particularmente uma nova categoria de recursos de software com um papel especializado. De acordo com o Fórum Internacional de Reguladores de Dispositivos Médicos (IMDRF), o SaMD é definido como "software destinado a ser utilizado para um ou mais fins médicos e que realiza esses fins sem fazer parte de um dispositivo médico de hardware".
Todos os produtos de desenvolvimento de software, quer sejam criados por uma pequena equipa ou por uma grande empresa, necessitam de documentação técnica para manter todos os intervenientes na mesma página e facilitar a navegação num percurso que, de outra forma, seria complicado. São criados e mantidos vários documentos ao longo do ciclo de vida de desenvolvimento de software (SDLC).
A documentação permite que as equipas de desenvolvimento, os testadores, os utilizadores e todas as outras pessoas envolvidas no projeto tenham alguma orientação e ajuda-os a atingir os seus objectivos. A conceção e o desenvolvimento destes documentos é um processo complicado que requer conhecimentos técnicos de redação.
A documentação do SaMD refere-se a guias do utilizador, manuais de operação, IFUs, tutoriais e outros materiais que descrevem o desenvolvimento, a funcionalidade e a utilização de um produto de software. A documentação é categorizada em:
- Documentação do produto: Descreve o produto que está a ser desenvolvido e fornece instruções para a realização de várias tarefas. A documentação do produto geralmente inclui requisitos, especificações técnicas, lógica comercial e manuais. Existem dois (02) tipos principais de documentação do produto:
- Documentação do sistema: Representa os documentos que descrevem o sistema e as suas partes. 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.
- Documentação do utilizador: Abrange os manuais que são preparados principalmente para os utilizadores finais do produto e administradores de sistemas. A documentação do utilizador inclui tutoriais, guias do utilizador, manuais de resolução de problemas, guias de instalação, IFUs 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 os guias normalizados, a documentação do projeto, como planos de projeto, calendários de testes, relatórios, notas de reuniões e até os que abrangem a correspondência comercial.
A principal diferença entre a documentação do processo e a documentação do produto é que a primeira regista o processo de desenvolvimento e a segunda descreve o produto que está a ser desenvolvido. Enquanto a documentação do produto se destina a públicos internos e externos, a documentação do processo destina-se principalmente às pessoas que estão a desenvolver o produto.
É certo que a criação de documentos para o SaMD é complicada, uma vez que os fluxos de trabalho variam consoante a empresa e o dispositivo médico. Sem nos aprofundarmos na utilização de modelos ou de quaisquer ferramentas de documentação, existem determinadas práticas recomendadas que, se forem seguidas, podem facilitar o processo de criação de documentos para o SaMD. Abaixo, listamos algumas das melhores práticas:
- Compreender a finalidade e o público-alvo do documento
- Anotar as perguntas importantes
- Esboço da documentação técnica
- Reunir as informações necessárias
- Escrever rascunhos de documentação
- Tirar partido de uma boa documentação visual
- Efetuar a edição final
Não há segredos escondidos para um bom processo de documentação para a SaMD. Este é conseguido através de um planeamento abrangente. Não é um esforço de uma só pessoa, mas requer uma colaboração estreita com os intervenientes relevantes, os programadores de software e outras partes direta ou indiretamente envolvidas no projeto. A adesão às melhores práticas, a abordagem de uma lista de pontos problemáticos e, acima de tudo, a manutenção do âmbito ajudará a preparar uma excelente documentação para o SaMD.
Contacte um perito em escrita técnica para obter mais informações sobre a documentação e as melhores práticas do SaMD e obter os Guias do Utilizador redigidos e documentados.
