PS-001 - Qualidade dos Documentos¶

Introdução¶

Toda a documentação produzida no interior da USF, incluindo documentos técnicos internos, normas, procedimentos, documentos para exposição pública, impressos, panfletos e correspondência, deve obedecer a regras comuns de estrutura, identificação, legibilidade e organização, de forma a assegurar coerência, rastreabilidade e uniformidade documental. Este procedimento foi atualizado para refletir a adoção do formato Markdown (.md) como formato-base para a criação, edição e manutenção de documentos internos. O Markdown permite criar documentos simples, legíveis, versionáveis e facilmente convertíveis para outros formatos, como PDF, HTML ou DOCX, quando necessário.

População Alvo¶

Equipa da USF Tempo de Cuidar – documentos produzidos internamente

Procedimento¶

Todos os documentos produzidos na USF Tempo de Cuidar deverão ser criados, sempre que aplicável, em formato Markdown (.md), utilizando uma estrutura textual normalizada.

A utilização de Markdown substitui a criação inicial de documentos em formato Word, permitindo:

• maior facilidade de edição;
• melhor controlo de versões;
• maior compatibilidade entre sistemas;
• simplificação da publicação em plataformas digitais;
• reutilização do conteúdo em diferentes formatos;
• separação entre conteúdo e formatação final.

Quando necessário, os documentos Markdown poderão ser convertidos para outros formatos, nomeadamente:

• PDF;
• HTML;
• DOCX;
• impressos para afixação;
• conteúdos para intranet ou outros repositórios digitais.

Documentos¶

Formato-Base¶

O formato-base dos documentos internos é o ficheiro Markdown, com extensão .md

Estrutura geral dos documentos¶

Os documentos devem conter, sempre que aplicável, as seguintes secções:

• Título do documento
• Introdução
• Definição ou enquadramento
• População-alvo
• Procedimento
• Fluxograma
• Notas
• Anexos
• Gestores do procedimento
• Registo de alterações

Registo de alterações¶

Todos os documentos devem conter um registo de alterações, colocado preferencialmente no final do documento, segundo o modelo:

|Revisão | Data de aprovação | Motivo da revisão | Validade | Autor |
|---|---|---|---|---|
| 1 | DD/MM/AAAA | Criação do documento | DD/MM/AAAA | Nome |
| 2 | DD/MM/AAAA | Atualização do procedimento | DD/MM/AAAA | Nome |

Nomenclatura dos documentos¶

A nomenclatura dos documentos técnicos deverá seguir a regra de código de duas letras, seguida de numeração sequencial de três dígitos:

• Procedimentos de Gestão: PG-00X
• Procedimentos Assistenciais: PA-00X
• Procedimentos de Suporte: PS-00X

A identificação deverá ser seguida do nome do procedimento. Exemplo:

PS-001 - Qualidade dos Documentos.md

Os anexos deverão utilizar a mesma nomenclatura, acrescentando um sufixo identificativo:

PS-001_A - Modelo de Documento.md

PS-001_B - Modelo de Panfleto.md

Regras de escrita em Markdown¶

Títulos e subtítulos¶

A hierarquia dos títulos deve respeitar a estrutura do documento.

  # Título principal
  ## Secção principal
  ### Subsecção
  #### Subsecção de nível inferior

Deve evitar-se saltar níveis de títulos. Por exemplo, não se deve passar diretamente de # para ###.

Destaques¶

Para destacar informação no texto, podem ser utilizados:

  **Texto em negrito**
  *Texto em itálico*

Tabelas¶

As tabelas devem ser utilizadas para informação estruturada.

  | Campo | Informação |
  |---|---|
  | Código | PS-001 |
  | Versão | 1 |
  | Data | DD/MM/AAAA |

Fluxogramas¶

Os fluxogramas deverão ser realizados preferencialmente com recurso à linguagem Mermaid, integrada diretamente no ficheiro Markdown. O código a utilizar pode ser copiado diretamente do editor visual em https://mermaid.live/edit.

```mermaid
flowchart TD
    A[Início] --> B[Executar procedimento]
    B --> C[Fim]
\`\`\`

Listas¶

- Item
- Item
  - Subitem

Documentos para divulgação externa¶

Os documentos destinados a divulgação externa, nomeadamente cartazes, ofícios, folhetos, panfletos ou outros materiais de comunicação, devem manter a identidade visual da USF Tempo de Cuidar e ULS-TS. Sempre que o conteúdo seja produzido inicialmente em Markdown, poderá ser posteriormente convertido ou adaptado para formatos gráficos ou de impressão. Devem ser respeitados, quando aplicável:

• utilização do logotipo da USF;
• coerência com as cores e elementos gráficos institucionais;
• inclusão dos logotipos oficiais necessários;
• legibilidade adequada ao público-alvo;
• indicação da data de elaboração ou revisão;
• identificação da entidade responsável.

Deverá ser utilizado o modelo .docx anexo.

Panfletos¶

No caso particular dos panfletos, o conteúdo textual poderá ser preparado em Markdown, facilitando a revisão, validação e controlo de versões. A composição gráfica final poderá ser realizada posteriormente em ferramenta apropriada, respeitando os modelos gráficos aprovados pela USF.

Impressos¶

Os impressos deverão estar identificados com o logotipo da USF e seguir uma nomenclatura própria. A nomenclatura recomendada é:

Mod.000_R0

Em que:

000 corresponde ao número sequencial do modelo;

R0 corresponde ao número da revisão.

Exemplo:

Mod.001_R0 - Pedido Interno.md

Armazenamento e controlo de versões¶

Os documentos Markdown serão armazenados numa pasta partilhada OneDrive, organizado e acessível aos profissionais autorizados. Recomenda-se que:

• cada documento tenha apenas uma versão-base em Markdown e a mesma seja replicada para fácil leitura no website Procedimentos USF Tempo de Cuidar;
• as versões exportadas para PDF ou DOCX sejam consideradas cópias de distribuição;
• as alterações sejam registadas no próprio documento;
• os documentos obsoletos sejam arquivados em pasta própria;
• a versão em vigor esteja claramente identificada.

Anexos¶

Anexo a esta norma e dela fazendo parte

• Modelos gráficos:
  • Folha A4 com logotipo superior
  • Folha A4 com logotipo inferior
  • Folha A4 horizontal
  • Modelo .docx

Gestores do procedimento¶

• Nuno Rodrigues
• Cristina Barbosa
• Gabriela Barbosa

Registo de alterações¶