Ticket #560: documentacao.txt

File documentacao.txt, 3.8 KB (added by viani, 15 years ago)

Proposta de documentação

Line 
1Site expressolivre.org:
2incluir apresentação do workflow na página 'apresentações'
3mover o conteúdo a página workflow para o wiki
4corrigir link 'changelog' na página 'download'
5
6Página home do wiki:
7incluir link para a referência de classes
8
9Parte I: Introdução
10melhorar o texto do preâmbulo
11fundir a página 'workflow' do expressolivre.org com as páginas de 'conceitos básicos' e 'componentes do workflow', formando um texto único, sem repetição de conceitos.
12
13Parte II: Instalação
14incluir no documento 'instalação do módulo workflow' como instalar a partir do pacote expresso.tar.gz
15modificar o documento 'configuração do módulo workflow' e no item 4 mostrar como cadatrar os administradores do módulo e desenvolvedores de processo.
16retirar referência à compilação do documento 'mais exemplos'
17modificar o documento sobre 'versão em desenvolvimento' para refletir a nova localizacao do workflow no svn
18no documento 'configuração avançada', citar que os parâmetros não documentados estão descritos no documento de processos (criar um link para ele).
19melhorar o código do processo 'Music CD Loans', cuidar com:
20- retorno true/false em todos os métodos da model;
21- incluir dispatch em todos os botões de ação;
22- constante para o schema de banco de dados;
23- padronização phpdocumentor, banco de dados, encapsulamento public/protected/private;
24- aplicar o template padrão;
25- usar exibição de erros padrão mvc;
26substituir os exemplos da Celepar por versões mais novas
27
28Parte III: Interface do usuários
29no documento 'lista de tarefas pendentes' colocar link para a configuração das ações
30no documento 'aplicações externas' incluir link para o documento de configuração de aplicações externas (ainda não redigido)
31no documento 'organograma' incluir link para o documento de configuração de organograma (ainda não redigido)
32
33Parte IV: Interface de administração
34no documento 'processos', explicar melhor os direitos sobre ações. Incluir os parâmetros de configuração de log.
35documentar o organograma
36documentar as aplicações externas
37documentar o mover instâncias
38documentar o controle de acesso utilizado para liberar os links do menu do workflow (menu lateral esquerdo)
39no documento 'atividades', criar um link para o documento 'agente de correio smtp' (ainda não documentado)
40no documento 'perfis' explicar que os perfis irão liberar acesso às atividades as quais estiverem associados. Isso irá formar o menu do processo.
41no documento 'edição de código' explicar outras formas de editar o código do processo além da interface web.
42alterar o documento 'lista de controle de acesso' para refletir a sua nova interface.
43
44Parte V: Desenvolvimento básico
45incluir a pasta 'logs' no documento 'codigo das atividades'
46no tutorial, mudar o endereço dos documentos para trac.expressolivre.org, pois está dando erro nos links.
47em todos os documentos deste tópico, verificar se estão de acordo com a padronização phpdoc
48utilizar um exemplo php que atravesse as três camadas, para dar uma visão completa ao usuário. Escolher um tema, p.ex. 'cadastrado de usuário'.
49em cada camanda incluir a padronização de código exigida para atributos, metodos, classes, etc. Suprimir o documento 'padroes de codificação workflow' depois disto.
50incluir em cada camanda um diagrama de classes.
51incluir um documento para explicar a folha de estilos css padrão
52revisar o tutorial quanto à padronização de código.
53mudar o documento 'perguntas frequentes' item acesso de administração, que está defasado.
54
55Parte VI: Metodologia
56revisar o texto dos documentos em geral
57eliminar o documento 'padrões de codificação workflow' que foi incorporado na Parte V.
58
59Parte VII: Interface de Monitoramento
60revisar o texto dos documentos em geral
61
62Parte VIII: Desenvolvimento avançado
63documentar os itens que estão em aberto
64revisar o texto dos documentos em geral
65
66Parte IX: Informações complementares
67eliminar esta seção e mover os documentos de DER para a Parte IV
68
69
70Em todas a partes componentes da documentação:
71atualizar imagens antigas
72criar um link 'próximo documento' - 'documento anterior' no rodapé da página