Padrão de Documentação da Wiki Araucária
Introdução ao Bookstack e ao Padrão de Documentação
A Wiki Araucária utiliza o Bookstack, uma plataforma de código aberto para criação e organização de documentação. O Bookstack permite que a prefeitura crie, edite e compartilhe informações de forma colaborativa, em um ambiente intuitivo e acessível. Para garantir que a Wiki Araucária seja uma ferramenta eficaz e consistente, este documento apresenta um padrão de documentação que deve ser seguido por todos os colaboradores. Este padrão estabelece diretrizes para a criação e edição de conteúdo, incluindo o uso de formatação, imagens, vídeos, tamanho do texto e outros elementos que contribuem para a qualidade e clareza da informação.
Objetivo
Este padrão tem como objetivo uniformizar a criação e edição de conteúdo na Wiki Araucária, garantindo que a documentação seja clara, acessível, consistente e profissional. Ao seguir estas diretrizes, facilitamos a colaboração, a busca por informações e o uso eficiente da plataforma por todos os colaboradores e usuários da Prefeitura de Araucária.
1. Estrutura e Organização
- Hierarquia Clara: Use títulos e subtítulos iniciando no h2 (h2, h3, etc.) para estruturar os artigos de forma lógica.
- Introdução Concisa: Cada página deve iniciar com uma breve introdução que resuma o conteúdo, indicando o que será abordado e por que é importante.
- Conteúdo Dividido em Seções: Divida o texto em seções menores, com títulos claros e descritivos, para facilitar a leitura e o entendimento.
- Sumário: Sempre que possível, utilize a função de Sumário (geralmente criada automaticamente pelo Bookstack com a estrutura de títulos) para permitir que os leitores naveguem facilmente pelo conteúdo.
- Links Internos: Utilize links internos para conectar páginas relacionadas dentro da Wiki. Isso facilita a navegação e o entendimento do contexto.
- Categorização: Use as tags (categorias) do Bookstack de forma consistente para classificar as páginas e facilitar a busca por assuntos.
2. Estilo e Formatação
- Linguagem Clara e Objetiva: Utilize uma linguagem clara, concisa e objetiva, evitando jargões técnicos ou expressões muito complexas que possam dificultar o entendimento por pessoas de diferentes áreas.
- Tom Formal: Mantenha um tom formal e profissional, adequado para um documento oficial da prefeitura.
- Frases Curtas e Simples: Prefira frases curtas e simples para garantir a clareza e facilitar a leitura.
- Parágrafos Concisos: Divida o texto em parágrafos curtos, com uma ideia principal cada, para manter a leitura fluida e organizada.
- Ênfase: Use negrito para destacar palavras ou frases importantes e itálico para citações ou termos técnicos. Evite o uso excessivo de formatação.
- Listas: Utilize listas com marcadores ou números para organizar informações de forma clara e concisa.
3. Imagens, Vídeos e Arquivos
- Imagens Relevantes: Use imagens para ilustrar os conteúdos, mas certifique-se de que elas sejam relevantes para o contexto, de alta qualidade e estejam bem dimensionadas.
- Legendas: Sempre inclua legendas descritivas para as imagens, explicando o que elas representam e seu propósito no texto.
- Vídeos: Utilize vídeos para complementar a documentação, como tutoriais ou apresentações. Esses vídeos devem ser incorporados a página para otimizar o uso de recursos do servidor.
- Formatos de Arquivos: Utilize formatos de arquivos padrão e acessíveis (PDF, ODT, ODS, DOCX, XLSX, etc.) para documentos e planilhas que precisem ser anexados.
- Nomeação de Arquivos: Utilize nomes de arquivos claros e descritivos, incluindo a data, quando relevante, para facilitar a busca e o controle de versões.
- Direitos Autorais: Verifique os direitos autorais de todas as imagens e vídeos utilizados. Use apenas materiais com licenças adequadas ou crie seu próprio material.
Exemplo Prático
Título da Página (h1): Procedimento para Solicitação de Diárias
Introdução: Este documento descreve o procedimento padrão para solicitação de diárias para servidores da Prefeitura de Araucária. O objetivo é garantir que todas as solicitações sejam feitas de forma correta, transparente e dentro das normas legais.
Requisitos (h2):
- Servidor em atividade
- Motivo da viagem justificado
- Autorização prévia do chefe imediato
- Documentação necessária anexada
- Etc.
Passos do Procedimento (h2):
- Preencher o formulário de solicitação online.
- Anexar os documentos comprovatórios (passagens, etc.).
- Submeter para aprovação do chefe imediato.
- Aguardar a confirmação e liberação da diária.
Observações (h2):
- Prazo mínimo para solicitação é de 5 dias úteis antes da viagem.
- A diária será paga via depósito em conta corrente.
Dúvidas (h2): Para mais dúvidas, entre em contato com o setor de TI.
 |
SECRETARIA MUNICIPAL DE CIÊNCIA, INOVAÇÃO, TECNOLOGIA E DESENVOLVIMENTO ECONÔMICO Paço Municipal Rua Pedro Druszcz, 111 (3º Andar) - Bairro: Centro (41) 3614-1593 (WhatsApp) |