Ir para o conteúdo

Padrão para Documentos da Wiki

Este documento tem como objetivo apresentar a padronização para os documentos que serão adicionados na WIKI de documentação do projeto Visualeasy, para o 1º semestre de 2022 da disciplina Engenharia de Produto de Software (EPS).

A primeira recomendação é quanto aos títulos do documento. Deve-se diferenciar títulos e subtítulos da seguinte forma:

Título

Usado para caracterizar o título principal do documento.

Subtítulo 1

Utilizado para tópicos principais do texto.

Subtítulo 2

Aplicado em subseções dos tópicos do texto.


Padrões de texto

Quanto aos textos, listam-se as seguintes recomendações:

  • Todos os textos devem ser justifados, utilizando a label:

    <p align="justify"> TEXTO </p>;

  • Palavras estrangeiras devem ser escritas em Itálico, utilizando a label:

    <i> TEXTO EM ITÁLICO </i>;

  • Para destacar alguma palavra ou trecho do texto, deve-se usar Negrito, utilizando a label:

    <b> TEXTO EM NEGRITO </b>;

  • Para pular uma linha, o seguinte comando pode ser utilizado:

    <br>


Listas

Se for necessário o uso de listas, elas devem ser da seguinte forma:

+: Para ponto principal;

-: :Para subpontos.

  • Primeiro ponto
  • Segundo ponto
  • Terceiro ponto
    • Primeiro subponto do terceiro ponto
    • Segundo subponto do terceiro ponto
  • Quarto ponto


Imagens

Imagens devem ser adicionadas utilizando o seguinte comando:

![apelido do arquivo](URL do arquivo)

E devem conter uma legenda, para detalhar do que se trata a imagem:

exemplo

Figura 1 - Exemplo de legenda para a imagem.


Vídeos

Em relação à vídeos, eles devem ser adicionados ao documento utilizando o seguinte código:

<iframe width="1366" height="483" src="https://www.youtube.com/embed/ABzDOSQkhTM" title="Imagens Incríveis da Natureza (4k)" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>



Arquivos PDF

Esse navegador não suporta arquivos em PDF. Por favor, faça o download do arquivo para visualizar: Download PDF.

<object data="../../docs/politicas/pdf-exemplo.pdf" type="application/pdf" width="700px" height="400px"> <embed src="../../docs/politicas/pdf-exemplo.pdf"> <p>Esse navegador não suporta arquivos em PDF's. Por favor, faça o download do arquivo para visualizar: <a href="../../docs/politicas/pdf-exemplo.pdf">Download PDF</a>.</p> </embed> </object>



Tabelas

A tabelas devem ser estruturadas da seguinte forma:

Título 1 Título 2 Título 3
Dado 1.1 Dado 2.1 Dado 3.1
Dado 1.2 Dado 2.2 Dado 3.2
Dado 1.3 Dado 2.3 Dado 3.3


Tabelas de versionamento

Todos os documentos adicionados nesta WIKI devem conter, ao final da página, uma tabela de versionamento contendo as seguintes informações:

  • Data da criação ou alteração do documento (DD/MM/AAAA);
  • Versão do documento, que inicia em 1.0;
  • Descrição da mudança que foi feita no documento;
  • Nome do autor ou autores do documento, com link para a conta do github do referente autor:
    • [Nome do autor](Link para a conta do GitHub do autor).


Versionamento

Data Versão Descrição Autor(es)
12/07/2022 1.0 Adiciona regras de padronização da WIKI Bruna Santos, Damarcones Porto, Itallo Gravina