Este Blog tem objetivo de manter informações sobre o estudo de desenvolvimento de software com UML.

terça-feira, junho 01, 2004

Documentos NOMENCLATURA e GLOSSÁRIO

Ainda no capítulo 2 o autor sugere a criação de um documento chamado NOMENCLATURA, que serve como padrão para todas as palavras envolvidas em estruturas de código, nos casos de uso ou ainda nas tabelas do banco de dados.
NOTA: Aqui na Meta, nós temos um padrão usado em todos os sistemas mas acho que deveríamos criar um documento contendo esses padrões, estando disponível facilmente através de uma intranet por exemplo..
Os novos colaboradores que se juntarem a equipe deverão se ADEQUAR aos formatos, e os formatos devem ser adotados de acordo com a empresa. A sugestão do autor é a seguinte:
Variáveis, Objetos e Classes
Escopo da Variável + Tipo da Variável + Nome da Variável
por exemplo:
iCodClinte -> variavel do tipo inteiro;
piCodCliente -> idem só que pública;
strNomeDoCliente -> Tipo String;
Nome de Operações
As operações ou métodos são prefixadas pelo tipo do seu retorno:
strObterNomeCliente -> O método retorna um tipoString;

NOTA: Bom, esses são os padrões que o autor do livro sugere, inclusive ele documenta TODAS AS VARIÁVEIS em uma lista, catalogando o prefixo que deverá ser usado. Acho que deveríamos ter um padrão desse tipo documentado, para cada uma das linguagens que trabalhamos, (VB6, VB.NET,....)

GLOSSÁRIO
Esse documento traduz para quem não conhece o software todos os termos usado pelo contrante. Tem função de agir como tradutor entre todos os participantes do processo de desenvolvimento do software.
NOTA: Na ferramente recem-adquirida (enterprise Architecth 4.0) existe suporte para o glossário, com uma separação para termos de negócio e termos técnicos.
Modelo de Glossário
Software: Locação de DVDs pela Internet
Locação - Ato de alugar um produto disponível no estoque da empresa.
Usuário Locador ou Cliente Locador - Aquele que aluga um produto.
... e assim vai ...


Próximos Capítulos
3. Caso de Uso
4. Diagrama de Atividades e Descrição dos Casos de Uso