Desenvolvimento Web - Nomenclatura

De DTI Wiki

1 - Pastas

Utilizar sempre a primeira palavra das pastas (tanto APPS quanto HTML) em minúsculo e a inicial da segunda em maiúsculo, sem a utilização de preposições. Ainda, o nome dos diretórios da pasta APPS e HTML devem ser idênticos.

Exemplo:

Correto		Errado
apps/academico/bolsaSocial/	html/academico/bolsaSocial/	apps/academico/bolsa_social/	html/academico/bolsa_social/
apps/academico/contraCheque/	html/academico/contraCheque/	apps/academico/contra_cheque/	html/academico/contra_cheque/
apps/academico/pontoProf/	html/academico/pontoProf/	apps/academico/ponto_de_prof/	html/academico/ponto_de_prof/

2 - Arquivos

Utilizar sempre a primeira palavra do nome dos arquivos (tanto na pasta APPS quanto HTML) em minúsculo e a inicial da segunda em maiúsculo, sem a utilização de preposições. Os arquivos HTML devem possuir após o nome e antes da extensão os caracteres "tpl".

Exemplo:

Correto	Errado
apps/academico/bolsaSocial/bolsaVestibular.php	apps/academico/bolsaSocial/bolsa_vestibular.php
apps/academico/bolsaSocial/ocorrenciaMnt.php	apps/academico/bolsaSocial/manutencao_ocorrencias.php
apps/academico/bolsaSocial/grupoFamiliar.tpl.html	apps/academico/bolsaSocial/grupoFamiliar.html
apps/academico/bolsaSocial/vizualizaJanela.tpl.html	apps/academico/bolsaSocial/vizualizaJanela.html
apps/academico/bolsaSocial/vistoDiretor.tpl.html	apps/academico/bolsaSocial/vistoDiretor.html

3. Aplicações e pastas

Devem seguir a tabela abaixo:

PASTAS		LOCALIZAÇÃO	EXTENSÃO
Imagens Gerais da Intranet	Imagens gerais de todas as aplicações da intranet.	/html/img/	.jpg .png .jpg
Imagens Específicas da aplicação	Imagens específicas de uma aplicação.	Terceiro nível da aplicação e devem estar no diretório imagens. Exemplo: /html/academico/aapa/imagens/ataExame.gif	.jpg .png .jpg
Scripts gerais (javascript)	Scripts gerais de todas as aplicações da intranet (exemplo: calendário, tipmessage).	/html/scripts/ Exemplo: /html/scripts/utils.js	.js
Scripts específicos da aplicação (javascript)	Scripts específicos da aplicação.	Terceiro nível da aplicação e devem estar no diretório js. Exemplo: /html/academico/aapa/js/professor.js	.js
Classes Gerais	Classes gerais de todas as aplicações da intranet Exemplo:	/lib/ Exemplo: /lib/urldataencode.class.php	.class.php
Classes Específicas	Classes específicos da aplicação.	Terceiro nível da aplicação (pasta APPS) /apps/rh/ponto/paginacao.class.php	.class.php