Pular para conteúdo

📘 Livro de Estilo SIGESC Docs

🎯 Objetivo

Este documento define os padrões editoriais utilizados na documentação oficial do SIGESC.
O propósito é garantir uniformidade, clareza e qualidade em todos os materiais publicados.


✍️ Princípios de Escrita

Toda documentação deve ser:

🔎 Clara

Utilizar linguagem objetiva, direta e compreensível.

⚙️ Técnica

Empregar termos oficiais do sistema, evitando ambiguidades.

📐 Consistente

Manter conceitos e nomenclaturas uniformes em todos os módulos.

🧾 Rastreável

Permitir identificar origem, versão e responsabilidade de cada documento.


📑 Estrutura Padrão de Documentos

Os documentos devem preferencialmente seguir o formato:

```markdown

Título

Objetivo

Contexto

Funcionamento

Regras

Referências