Formato de documentação sugerida para documentação de sistema desenvolvido em Joomla

Para determinada funcionalidade/interface desenvolvida:

1) Construir o diagrama de caso de uso. Este diagrama deve detalhar o que cada ator pode acessar na interface/funcionalidade desenvolvida, quais ações podem ser executadas, as possibilidades existentes etc.

2) Construir o diagrama de classes. Escrever cada classe envolvida no processo, com os principais métodos.

3) Construir o diagrama de sequência. É um dos diagramas mais complexos. Aqui, os atores, o conceito da interface/funcionalidade desenvolvida e as classes do diagrama de classes, são associadas e demonstradas em sequência temporal de execução. Existe uma mistura entre conceito e programação.

4) Construir o diagrama de atividades. Demonstra a funcionalidade/interface em um diagrama muito parecido com os fluxogramas. É um diagrama totalmente conceitual, de modo que não envolve códigos, objetos, classes, nada que seja relacionado à programação.

5) Construir o diagrama de implantação. Demonstra onde os artefatos serão implementados (onde os arquivos e banco de dados serão armazenados nos servidores)

6) Construir o diagrama de componentes. É a visão macro das principais partes da funcionalidade/interface desenvolvida, e como essas partes se relacionam.