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 ====

Nomes de tabelas devem devem obedecer os seguintes critérios:

-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 ====

Nomes dos campos de tabelas devem devem obedecer os seguintes critérios:

-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 registros devem obedecer os seguintes critérios::

-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 um registro devem obedecer os seguintes critérios:

-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 um registro devem obedecer os seguintes critérios:

-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 ====

Nomes de tabelas devem obedecer os seguintes critérios:

-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 devem obedecer os seguintes critérios:

-Nomes no singular.

-Todos os caracteres em minúsculo.

-Possuir o predecessor constituido de 3 caracteres. Ex.: tb_cliente -> cli_nome.

-Nomes compostos separados pelo caracter "_".

<note tip>
Se o predecessor se repetir, poderá ser adotado 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>

====== Nomeclatura de classes, métodos e propriedades ======

===== Nome de classes =====

Nome de classes devem obedecer os seguintes critérios:

-Primeiro caracter em maiúsculo.

-Nomes no singular.

-Nome da tabela no qual a classe representa. Ex.: Tabela de produtos, nome da classe "Produto".

-Quando possuir palavras compostas, adotar o formato underlinecase para PHP e camelcase para as demais linguagens.

===== Nome de métodos =====

Os nomes dos métodos devem obedecer os seguintes critérios:

-Primeiro caracter em minúsculo.

-Nomes no singular.

-Quando possuir palavras compostas, adotar o formato underlinecase para PHP e camelcase para as demais linguagens.

-O nome deve refletir a ação do método. 
  - save (para atualizar ou inserir um registro).
  - delete (para excluir um registro).
  - get_all ou getAll (para recuperar todos os registros).
  - getById ou get_by_id (para recuperar o registro pelo id).

-Métodos para recuperar uma propriedade devem preceder da palavra "get" e "set" quando alteram.

===== Nome de propriedades =====

Os nomes das propriedades devem obedecer os seguintes critérios:

-Primeiro caracter em minúsculo.

-Nomes no singular.

-Quando possuir palavras compostas, adotar o formato underlinecase para PHP e camelcase para as demais linguagens.

====== Layout ======

===== Cabeçalho =====

  * Cor de fundo: #F7F7F7
  * Altura: 80px
  * Largura: 100% (exceto em aplicações web, centralizado em 1024px)
  * Logo da aplicação posicionado a esquerda e centralizado na vertical com espaçamento de 20px a esquerda 
  
  Borda que divide o cabeçalho e o menu
    * Cor de fundo: cor principal da aplicação
    * Altura: 1px
    * Largura: 100%
 
<html>
  <table>
    <tr>
        <td>Aplicação</td>
        <td>Imagem</td>
        <td>Cor principal</td>
        <td>Cor secundária</td>
    </tr>
    <tr>
        <td>Cotação</td>
        <td></html>{{::co.png?nolink }}<html></td>
        <td>#2F86D4</td>
        <td>#81B9E8</td>
    </tr>
    <tr>
        <td>EasyCash</td>
        <td></html>{{:ec.png?nolink }}<html></td>
        <td>#6E2152</td>
        <td>#A57C96</td>
    </tr>
    <tr>
        <td>IntelliGroup</td>
        <td></html>{{:ig.png?nolink }}<html></td>
        <td>#D91427</td>
        <td>#EDA67C</td>
    </tr>
    <tr>
        <td>IntelliStock</td>
        <td></html>{{:is.png?nolink }}<html></td>
        <td>#1D6437</td>
        <td>#82A081</td>
    </tr>
    <tr>
        <td>IntelliStock Mobile</td>
        <td></html>{{:is_mobile.png?nolink }}<html></td>
        <td>#1D6437</td>
        <td>#82A081</td>
    </tr>
    <tr>
        <td>IntelliCash</td>
        <td></html>{{::ic.png?nolink }}<html></td>
        <td>#122C5F</td>
        <td>#7B91B4</td>
    </tr>
    <tr>
        <td>Venda Assistida</td>
        <td></html>{{::va.png?nolink }}<html></td>
        <td>#E5701F</td>
        <td>#F3B982</td>
    </tr>
    <tr>
        <td>Intelliweb</td>
        <td></html>{{::iw.png?nolink }}<html></td>
        <td>#DBB93D</td>
        <td>#EEDBA1</td>
    </tr>
    <tr>
        <td>GNFE</td>
        <td></html>{{::gnfe.png?nolink }}<html></td>
        <td>#122C5F</td>
        <td>#7B91B4</td>
    </tr>  
  </table>
</html>


===== Menu =====

    * Cor de fundo: #F7F7F7
    * Altura: 33px
    * Largura: 100% (exceto em aplicações web, centralizado em 1024px)
    * Borda inferior: 1px #D5D5D5
    * Cor da fonte: #000000
    * Fonte: Arial 13px

{{::screenhunter_21_jan._28_11.32.jpg?nolink|}}

===== Barra de título =====

  * Degrade: Sup. #777777 Inf. #555555
  * Fonte: Arial 12px centralizado #FFFFFF
  
{{::screenhunter_22_jan._28_11.53.jpg?nolink|}}
Documentação de software

Ferramentas do usuário

Ferramentas do site

Ferramentas da página
