📝👩🏽‍💻📖 documentacaoProjeto

O que é documentação de um projeto? Quais são os itens necessários?

📝 O que é documentação de um projeto?

A documentação é composta por uma série de informações em que os aspectos de um projeto de tecnologia, desta forma, a gestão de projetos se certifica que todos os profissionais tenham um fácil acesso e compreensão do software quanto os os usuários.

📝 Itens de uma documentação de software

• dados dos servidores
• internet
• roteamento e endereçamento IP
• topologia de rede
• ativos de rede
• políticas de funcionamento da criação de usuário, segurança, instalações de softwares
• principais contatos dentro do cliente
• contatos dos fornecedores de rede e equipamentos.

📝 Ferramentas para Documentação

1. PlantUML https://plantuml.com/
2. Postman https://www.postman.com/
3. APIblueprint https://apiblueprint.org/
4. Swagger https://swagger.io/

📝 Gerenciamento

O gerenciamento de cada uma das etapas e da implementação é muito importante, desta forma, separando por processos permite uma compreensão melhor.

• Gerenciamento do tempo
• Gerenciamento dos custos
• Gerenciamento da qualidade
• Gerenciamento do escopo
• Gerenciamento das aquisições
• Gerenciamento dos riscos

📝 Documentação de API

1. Swagger https://swagger.io/
2. APIblueprint https://apiblueprint.org/
3. RAML https://raml.org/

📝 Métodos para visualização dos processos e requisitos

• Diagramas de Casos;
• Mapas mentais
• Diagramas Sequenciais;
• Fluxogramas de processos;
• Diagramas de Decomposição Funcionais