Documentação de software

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.
====== Nomeclatura de tabelas e procedures ======

===== Padrões gerais =====

==== Nome de tabelas ====

O nome das tabelas devem representar os objetos no qual serão associados seguindo os critérios abaixo:

-Nomes sempre no plural.

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

Caso o nome da tabela ultrapasse os 30 caracteres, deverá ser utilizado a seguinte regra para abreviação das palavras:

-Cortar a palavra até a primeira letra da segunda sílaba. Ex.: PRODUTOS -> PROD
  
==== Nome dos campos ====

Tabelas desem seguir as seguintes regras:

-Possuir o campo "ID" como chave primária.

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

==== Procedures ====

O nome das procedures devem representar as operações que serão executadas pelas mesmas.

=== Listar ===

Procuderes para recuperar informações devem respeitar as seguintes regras:

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

-Iniciar a procedure com a palavra "GET". Ex.: GETPRODUTOS (recupera registros na tabela de produtos).

<note tip>Caso o nome da procedure ultrapasse os 30 caracteres, deverá ser utilizado a seguinte regra para abreviação das palavras:

-Cortar a palavra até a primeira letra da segunda sílaba. Ex.: PRODUTOS -> PROD</note>

=== Inserir ou atualizar ===

Procedures para inserir ou atualizar uma informação devem atender as seguintes regras:

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

-Iniciar a procedure com a palavra "ADDUPDT". Ex.: ADDUPDTPRODUTOS (insere ou atualiza um registro na tabela de produtos).

<note tip>Caso o nome da procedure ultrapasse os 30 caracteres, deverá ser utilizado a seguinte regra para abreviação das palavras:

-Cortar a palavra até a primeira letra da segunda sílaba. Ex.: PRODUTOS -> PROD</note>

=== Excluir ===

Procedures para excluir uma informação devem atender as seguintes regras:

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

-Iniciar a procedure com a palavra "DEL". Ex.: DELPRODUTOS (exclui um registro na tabela de produtos).

<note tip>Caso o nome da procedure ultrapasse os 30 caracteres, deverá ser utilizado a seguinte regra para abreviação das palavras:

-Cortar a palavra até a primeira letra da segunda sílaba. Ex.: PRODUTOS -> PROD</note>

===== Padrões Web =====

==== Nome de tabelas ====

O nome das tabelas devem representar os objetos no qual serão associados seguindo os critérios abaixo:

-Nomes no singular.

-Todos os caracteres em minúsculo.

-Possuir o predecessor "tb_". Ex.: tb_usuario.

-Nomes compostos separados pelo caracter "_".

-Todas as tabelas devem possuir o campo id como //auto increment// e //primary key//.

==== Nome dos campos ====

Nomes de campos desem seguir as seguintes regras: 

-Nomes no singular.

-Todos os caracteres em minúsculo.

-Possuir o predecessor constituido dos 3 primeiros caracteres da tabela. Ex.: tb_cliente -> cli_nome.

-Nomes compostos separados pelo caracter "_".

<note tip>
Se o predecessor se repetir, poderá ser adotados as seguintes regras:

-Para tabelas compostas por 2 nomes, pegar os 2 primeiros caracteres do primeiro nome e o primeiro caracter do segundo nome. Ex.: tb_empresa_estoque -> eme_

-Para tabelas compostas por 3 nomes, pegar o primeiro caracter de cadas palavra. Ex.: tb_empresa_produto_venda -> epv_.
</note>
Documentação de software

Ferramentas do usuário

Ferramentas do site

Ferramentas da página
