Gerenciamento da Documentação

1. Gerenciamento da Documentação Walter de Abreu Cybis Novembro, 2003 Laboratório de Utilizabilidade da Informática Departamento de Informática e Estatística Universidade Federal de Santa Catarina

2. Gerenciamento da Documentação • Definição • Conjunto de atividades que se incubem da geração, circulação, armazenamento e recuperação de informações originadas no decorrer do projeto • Enquanto o projeto é “hóspede” de uma organização, a documentação é uma “filha” que o projeto gera quando de sua execução. Além dos resultados, um projeto passará a sua documentação todas as suas virtudes, deficiências e carências...

3. Gerenciamento da Documentação • Finalidades da Documentação do Projeto • Comunicação no âmbito do projeto • Doc. técnica, gerencial, administrativa • Comunicação com o cliente (comunidade) • Manuais, relatórios, artigos técnicos e científicos • Comunicação com o futuro / repositório • Acervo para posteriores consultas ao projeto • Ex. Doc. técnica, gerencial, administrativa, métricas, manutenção

4. Gerenciamento da Documentação • Tipos de Documentação segundo sua natureza • Doc. Técnica • Especificações, modelagens, programas,cadernos de testes, ... • Doc. Gerencial • Planejamento básico • Planejamento detalhado • Acompanhamento da execução • Doc. Administrativa • Controle de pesssoal, Controle financeiro, correspondências,...

5. Gerenciamento da Documentação • Tipos de Documentos segundo as fases do desenvolvimento • Doc de Planejamento • Planos e especificações • Doc. de Execução • Documentos que Registram como os problemas foram resolvidos e como o produto foi concebido • Doc. de Conclusão • Documentos que deverão ser repassados ao cliente

6. Gerenciamento da Documentação • Sistema de Documentação Técnica • geração, circulação, armazenamento e recuperação de informações originadas no decorrer do projeto • Plano de Documentação • Orientam a geração da documentação do projeto. • Relatório da Documentação • Registram os documentos que foram gerados no projeto

7. Gerenciamento da Documentação • Plano de Documentação • Finalidades • Estabelecer a ESTRUTURA e o RELACIONAMENTO do Sistema de Documentação Técnica • Definir a Identificação dos documentos • Prescrever os documentos a serem gerados • Designar os responsáveis pela elaboração destes documentos • Estabelecer as articulações de consolidação e rastreabilidade dos documentos • Fixar requisitos de qualidade da documentação • Estabelecer formas de controle da documentação

8. Gerenciamento da Documentação • Sistema de Documentação Técnica • Estrutura • Homóloga a organização do projeto

9. Gerenciamento da Documentação • Sistema de Documentação Técnica • Funcionamento/relacionamentos • Articulação • Conexão entre documentos relacionados • Articulação Vertical / Rastreabilidade • Conexão entre documentos onde uns geram os outros • Articulação Horizontal / Consolidação • Conexão entre documentos de mesmo nível

10. Especificação de P Especificação de P.02 Especificação de P.02.01 Solicitação de teste de P Solicitação de teste de P.02 Solicitação de teste de P.02.01 Gerenciamento da Documentação • Sistema de Documentação Técnica • Funcionamento • Articulação Vertical / Rastreabilidade

11. Gerenciamento da Documentação • Sistema de Documentação Técnica • Funcionamento • Articulação Horizontal / Consolidação Documentação de P Doc. de Especificação Doc. Modelagem Doc. Projeto detalhado Caderno de Testes Listagens de código Componente compilado

12. Gerenciamento da Documentação • Sistema de Documentação Técnica • Funcionamento • Aprovação • Os documentos devem ser assinados por seus autores/responsáveis técnicos • Aprovados pelos chefes, gerentes e diretores • Circulação • Os documentos devem ser enviados a seus clientes, conforme definido no Plano da Documentação

13. Gerenciamento da Documentação • Sistema de Documentação Técnica • Funcionamento • Armazenamento e Recuperação de documentos • Arquivamento dos originais com vistas a reproduções futuras • Processo de classificação • Descritores, Tesauros, palavras-chave,, • Sumários, resumos, índices

14. Gerenciamento da Documentação • Sistema de Documentação Técnica • Funcionamento • Controle • Verificar a conformidade da documentação em relação as normas estabelecidas no Plano da Documentação • Ferramentas • Rational SoDA • FloxPort • Document Manager • IDMS Intelligent Documentation Management System • MIIT Script • AutoManager WorkFlow 6.3 • Docuxplorer Pro V. 2