Como elaborar uma documentação de software?

Opa amigo, fiz isto semestre passado! tenho alguns materiais que pode te ajudar muito

Aqui está o link que postei de um modelo de documentação de software que usei >> https://www.passeidireto.com/arquivo/31215381/modelo-de-documentacao-de-software

Se tiver dúvidas em relação à diagramas de caso de uso, diagramas de classes, diagramas de sequencia, diagramas de estado, etc.. Recomendo que leia o livro da UML que é muito bem explicado esses aspectos >> https://www.passeidireto.com/arquivo/31215392/apostila-sobre-a-uml---bem-explicada

Bons estudos! Qualquer dúvida estou à disposição!

Criei uma pasta com nome “Documentação Processo” dentro dela existem subpastas “Desenvolvimento” “Requisitos” “Tecnologias Adotadas” dentro delas existem outras pastas com informações referentes a cada.

Desenvolvimento:

• Commits: janeiro.txt = Criada nova funcionalidade para tal funcionalidade.

• Histórico de tarefas: abril.txt = Histórico desenvolvimento da tarefa tal.

• Relatório Técnico: Módulo de Busca.pdf, Plugin-autodescrição.pdf, Plugin-comandos.

• Requisitos:

• Reuniões: Reuniao22-10-2018.pdf, Dentro do documento contém: Objetivo da reunião, informações e futuras mudanças.

• UML: Subpastas

• Documentos Técnicos: Módulos Admistradores.pdf, Módulos Destaque.pdf, Módulos Financeiro.pdf.

• Módulo Administrador: Contendo as seguintes subpastas “Diagrama de Atividade”, “Diagrama de caso de uso”, “Diagrama de Classes”, “Diagrama de Sequencia”.

• Módulo Destaque: Contendo as seguintes subpastas “Diagrama de Atividade”, “Diagrama de caso de uso”, “Diagrama de Classes”, “Diagrama de Sequencia”.

• Módulos Financeiro: Contendo as seguintes subpastas “Diagrama de Atividade”, “Diagrama de caso de uso”, “Diagrama de Classes”, “Diagrama de Sequencia”.

• Módulo Site: Contendo as seguintes subpastas “Diagrama de Atividade”, “Diagrama de caso de uso”, “Diagrama de Classes”, “Diagrama de Sequencia”.

• Todas essas subpastas dentro de uml têm diagramas para mostrar onde ficam essas estruturas de diretórios auxiliam na documentação.

• Tecnologias Adotadas: Um exemplo para você descrever as tecnologias adotadas para o seu sistema.

• Framework estrutural: Yii framework

• Servidor de aplicação: Apache 2

• Sistema Gerenciador de banco de dados: Oracle

• Adaptação em HTML5 com modernz