plano-documentacao-tatica-estrategica.md

1. Descrição do motivo que explica a importância do plano: Com a crescente demanda de profissionais da área de tecnologia, é essencial que as equipes trabalhem de maneira eficiente e produtiva. A documentação de software é uma das ferramentas mais importantes para garantir que todos os membros da equipe possam entender o projeto como um todo, além de ser essencial para manutenção e escalabilidade do software. Este plano de estudos visa capacitar a pessoa a escrever documentações de software que facilitem a comunicação dentro da equipe e permitam que outros membros da equipe compreendam o software como um todo.

2. Objetivo de aprendizagem: Ao final deste plano de estudos, a pessoa será capaz de escrever documentações de software que facilitem a comunicação dentro da equipe e permitam que outros membros da equipe compreendam o software como um todo, conectando-se com o nível 3 da taxonomia de Bloom.

3. Pré-requisitos: Para seguir este plano de estudos, é necessário que a pessoa tenha conhecimentos básicos em programação e habilidades de escrita em português.

4. Lista de objetivos de aprendizagem conectados com o nível 3 da taxonomia de bloom:

• Escrever documentações claras e concisas para o software.
• Identificar e documentar os requisitos do software.
• Documentar o design do software.
• Documentar a arquitetura do software.
• Documentar o processo de desenvolvimento do software.
• Documentar as técnicas de teste e depuração do software.
• Documentar o uso do software e as instruções de instalação.

5. Lista de temas que serão abordados no plano ordenados por uma sequência lógica de consumo: Tema 1: Introdução à documentação de software

• Referência: "Documenting Software Architectures: Views and Beyond" de Paul Clements, Felix Bachmann, Len Bass, David Garlan, James Ivers, Reed Little, Paulo Merson, Robert Nord, and Judith Stafford
• Objetivo de aprendizagem específico: Compreender a importância da documentação de software para a comunicação dentro da equipe.

Tema 2: Documentando requisitos do software

• Referência: "Writing Effective Use Cases" de Alistair Cockburn
• Objetivo de aprendizagem específico: Identificar e documentar os requisitos do software de maneira clara e objetiva.

Tema 3: Documentando o design do software

• Referência: "UML Distilled: A Brief Guide to the Standard Object Modeling Language" de Martin Fowler
• Objetivo de aprendizagem específico: Documentar o design do software utilizando a linguagem UML.

Tema 4: Documentando a arquitetura do software

• Referência: "Documenting Software Architectures: Views and Beyond" de Paul Clements, Felix Bachmann, Len Bass, David Garlan, James Ivers, Reed Little, Paulo Merson, Robert Nord, and Judith Stafford
• Objetivo de aprendizagem específico: Documentar a arquitetura do software utilizando diferentes pontos de vista.

Tema 5: Documentando o processo de desenvolvimento do software

• Referência: "Software Requirements and Estimation" de Swapna Kishore e Rajesh Naik
• Objetivo de aprendizagem específico: Documentar o processo de desenvolvimento do software, incluindo as metodologias utilizadas.

Tema 6: Documentando o uso do software e instruções de instalação

• Referência: "Documenting APIs: A guide for technical writers and engineers" de Kirsten Hunter
• Objetivo de aprendizagem específico: Documentar o uso do software e as instruções de instalação para facilitar a adoção do software.

6. Lista de palavras chave:

• Documentação de software
• Requisitos
• Design
• Arquitetura
• Processo de desenvolvimento
• Teste e depuração
• Uso e instalação

7. Exercícios:
8. Escreva um documento de requisitos de um software que você desenvolveria para resolver um problema real.
9. Documente o design do software utilizando a linguagem UML.
10. Escreva um documento de arquitetura de software utilizando diferentes pontos de vista.
11. Documente o processo de desenvolvimento do software utilizando uma metodologia de sua escolha.
12. Escreva um manual de uso do software e as instruções de instalação.