Padrão de Documentação da Wiki Araucária

IntroduçãIntrodução ao Bookstack e ao PadrãPadrão de DocumentaçãDocumentação

A Wiki AraucáAraucária utiliza o Bookstack, uma plataforma de cócódigo aberto para criaçãcriação e organizaçãorganização de documentaçãdocumentação. O Bookstack permite que a prefeitura crie, edite e compartilhe informaçõinformações de forma colaborativa, em um ambiente intuitivo e acessíacessível. Para garantir que a Wiki AraucáAraucária seja uma ferramenta eficaz e consistente, este documento apresenta um padrãpadrão de documentaçãdocumentação que deve ser seguido por todos os colaboradores. Este padrãpadrão estabelece diretrizes para a criaçãcriação e ediçãedição de conteúconteúdo, incluindo o uso de formataçãformatação, imagens, vívídeos, tamanho do texto e outros elementos que contribuem para a qualidade e clareza da informaçãinformação.

Objetivo

Este padrãpadrão tem como objetivo uniformizar a criaçãcriação e ediçãedição de conteúconteúdo na Wiki AraucáAraucária, garantindo que a documentaçãdocumentação seja clara, acessíacessível, consistente e profissional. Ao seguir estas diretrizes, facilitamos a colaboraçãcolaboração, a busca por informaçõinformações e o uso eficiente da plataforma por todos os colaboradores e usuáusuários da Prefeitura de AraucáAraucária.

1. Estrutura e OrganizaçãOrganização

• Hierarquia Clara: Use títítulos e subtísubtítulos iniciando no h2 (h2, h3, etc.) para estruturar os artigos de forma lólógica.
• IntroduçãIntrodução Concisa: Cada pápágina deve iniciar com uma breve introduçãintrodução que resuma o conteúconteúdo, indicando o que seráserá abordado e por que éé importante.
• ConteúConteúdo Dividido em SeçõSeções: Divida o texto em seçõseções menores, com títítulos claros e descritivos, para facilitar a leitura e o entendimento.
• SumáSumário: Sempre que possípossível, utilize a funçãfunção de SumáSumário (geralmente criada automaticamente pelo Bookstack com a estrutura de títítulos) para permitir que os leitores naveguem facilmente pelo conteúconteúdo.
• Links Internos: Utilize links internos para conectar pápáginas relacionadas dentro da Wiki. Isso facilita a navegaçãnavegação e o entendimento do contexto.
• CategorizaçãCategorização: Use as tags (categorias) do Bookstack de forma consistente para classificar as pápáginas e facilitar a busca por assuntos.

2. Estilo e FormataçãFormatação

• Linguagem Clara e Objetiva: Utilize uma linguagem clara, concisa e objetiva, evitando jargõjargões tétécnicos ou expressõ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áParágrafos Concisos: Divida o texto em pará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áitálico para citaçõcitações ou termos tétécnicos. Evite o uso excessivo de formataçãformatação.
• Listas: Utilize listas com marcadores ou núnúmeros para organizar informaçõinformações de forma clara e concisa.

3. Imagens, VíVídeos e Arquivos

• Imagens Relevantes: Use imagens para ilustrar os conteú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ópropósito no texto.
• VíVídeos: Utilize vívídeos para complementar a documentaçãdocumentação, como tutoriais ou apresentaçõ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ãpadrão e acessíacessíveis (PDF, ODT, ODS, DOCX, XLSX, etc.) para documentos e planilhas que precisem ser anexados.
• Nomeaçã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õversões.
• Direitos Autorais: Verifique os direitos autorais de todas as imagens e vívídeos utilizados. Use apenas materiais com licençlicenças adequadas ou crie seu própróprio material.

---

Exemplo PráPrático

TíTítulo da PáPágina (h1): Procedimento para SolicitaçãSolicitação de DiáDiárias

IntroduçãIntrodução: Este documento descreve o procedimento padrãpadrão para solicitaçãsolicitação de diádiárias para servidores da Prefeitura de AraucáAraucária. O objetivo éé garantir que todas as solicitaçõsolicitações sejam feitas de forma correta, transparente e dentro das normas legais.

Requisitos (h2):

• Servidor em atividade
• Motivo da viagem justificado
• AutorizaçãAutorização préprévia do chefe imediato
• DocumentaçãDocumentação necessánecessária anexada
• Etc.

Passos do Procedimento (h2):

1. Preencher o formuláformulário de solicitaçãsolicitação online.
2. Anexar os documentos comprovatócomprovatórios (passagens, etc.).
3. Submeter para aprovaçãaprovação do chefe imediato.
4. Aguardar a confirmaçãconfirmação e liberaçãliberação da diádiária.

ObservaçõObservações (h2):

• Prazo mímínimo para solicitaçãsolicitação éé de 5 dias úúteis antes da viagem.
• A diádiária seráserá paga via depódepósito em conta corrente.

DúDúvidas (h2): Para mais dúdúvidas, entre em contato com o setor de TI.

---

SECRETARIA MUNICIPAL DE CIÊCIÊNCIA, INOVAÇÃINOVAÇÃO, TECNOLOGIA E DESENVOLVIMENTO ECONÔECONÔMICO PaçPaço Municipal Rua Pedro Druszcz, 111 (3º3º Andar) - Bairro: Centro (41) 3614-1593 (WhatsApp) smcit@araucaria.pr.gov.br