DS & II

GUIA_PADRONIZACAO_CURSO

Leitura de 3 min

Guia de Padronização para Cursos de Programação

Este guia estabelece os padrões de estrutura, didática e organização de código adotados para os cursos da plataforma. O objetivo é garantir uma experiência de aprendizagem consistente, imersiva e profissional para os alunos.

1. Estrutura de Arquivos e Pastas

1.1. Organização do Repositório

Cada curso deve seguir uma estrutura limpa e previsível:

nome-do-curso/
├── capitulos/                  # Arquivos markdown com a teoria e práticas
│   ├── capitulo_01_...md
│   └── codigos/                # Pasta CENTRAL de códigos
│       ├── cap01/
│       │   ├── lib/            # Bibliotecas externas necessárias
│       │   └── src/            # Código-fonte puro
│       └── cap02/
└── GUIA_PADRONIZACAO_CURSO.md  # Este guia

1.2. Padrão de Projeto

Para facilitar o uso por alunos iniciantes, a pasta de códigos de cada capítulo deve simular um projeto padrão da tecnologia utilizada:

  • src/: Contém os arquivos de código fonte.
  • lib/: Deve conter as dependências físicas quando aplicável.

2. Padrão para Arquivos de Conteúdo (.md)

Cada capítulo deve ser um arquivo Markdown contendo:

2.1. Cabeçalho e Tematização

  • Título Imersivo: Use emojis e temas do universo Geek/Gamer para engajar o aluno.
  • Contextualização: Toda prática deve ter um “porquê” dentro do tema.

2.2. Estrutura do Conteúdo

  1. Conceito Teórico: Explicação breve e direta do conceito.
  2. Exemplo Guiado: Código completo com comentários explicativos.
  3. 🕹️ Seção “Como Executar”: Passo a passo de como rodar o exemplo.
  4. Resultado Esperado: Tabela ou bloco de texto mostrando o que deve aparecer no terminal.
  5. 🛠️ Práticas Obrigatórias: Exercícios para o aluno fazer.
  6. 🔑 Gabarito de Código: No final do arquivo, o código completo das práticas.

2.3. Seção “Como Executar” (Obrigatória)

Todo exemplo de código deve vir acompanhado de instruções de execução:

#### 🕹️ Como Executar e Testar
1. Abra o arquivo de código.
2. Execute o comando apropriado ou use o botão Run.
3. Verifique o resultado no terminal.
 
**Resultado Esperado:**
[Descrição ou print do que deve aparecer]

3. Instruções de Entrega (Padrão Unificado)

Todos os capítulos devem terminar com a mesma instrução de entrega:

## 📤 Instruções de Entrega (GitHub Desktop + Microsoft Teams)
 
1. **Faça o Commit:** No GitHub Desktop, digite a mensagem (ex: `Finaliza Capítulo X`) e clique em **Commit to main**.
2. **Envie para a Nuvem (Push):** Clique em **Push origin**.
3. **⚠️ IMPORTANTE:** Seu repositório DEVE SER PÚBLICO.
4. **No Microsoft Teams:**
   * Copie o link do seu repositório.
   * Cole na tarefa correspondente no Teams.
   * Clique em **Entregar**.

Este guia deve ser adaptado para a linguagem/tema específico do módulo.

Visão de gráfico

Backlinks