Le file README explica le objectivo del projecto.
O arquivo README explica o objetivo do projeto.
Documentação técnica inicial
Primeira vez aqui?
Cada tema tem etapas curtas, uma de cada vez.Esta é a primeira: a Aula. Quando terminar de ler, toque em Concluir aula e ir ao vocabulário. Seu progresso fica salvo sozinho — pode sair e voltar quando quiser.
Precisa de uma fonte mais confortável? Abra Menu → Preferências.
Tema 108 · Aula
Você vai aprender estas frases
Ouça cada frase e tente repeti-la.
Se quiser, grave sua voz para comparar. A gravação não é enviada.
Le changelog lista le cambios de cata version.
O changelog lista as mudanças de cada versão.
Ver dica
Changelog registra evolução do software.Le instructiones de installation indica como configurar le ambiente.
As instruções de instalação indicam como configurar o ambiente.
Ver dica
Instruções devem seguir uma ordem executável.Ante comenciar, verifica le requisitos del systema.
Antes de começar, verifique os requisitos do sistema.
Ver dica
Requisitos vêm antes dos comandos principais.Si un error appare, consulta le section de problemas.
Se aparecer um erro, consulte a seção de problemas.
Ver dica
Uma rota de diagnóstico reduz bloqueios.Un bon documento usa titulos e exemplos clar.
Um bom documento usa títulos e exemplos claros.
Ver dica
Estrutura e exemplos melhoram a autonomia do leitor.Nível: B1
Objetivo
Ler e redigir a estrutura inicial de documentação técnica em interlíngua: README, changelog e instruções de instalação.
Explicação
Documentação técnica deve permitir que outra pessoa entenda o projeto e repita uma tarefa. Um README apresenta objetivo, uso rápido e requisitos. As instructiones de installation explicam pré-requisitos, configuração e comandos em ordem. Um changelog registra mudanças por versão, sem recontar toda a história. Use títulos claros, exemplos copiáveis e avisos para erros comuns.
Erros comuns
- Escrever um README que descreve apenas o projeto, sem explicar como começar.
- Omitir versões, dependências ou requisitos do ambiente.
- Misturar mudanças históricas com instruções atuais de instalação.
- Dar comandos sem explicar onde executá-los ou qual resultado esperar.
Resumo
README orienta objetivo e uso; instruções explicam instalação em ordem; changelog registra mudanças. Títulos, requisitos, comandos e problemas devem ser claros.
Ler e redigir a estrutura inicial de documentação técnica em interlíngua: README, changelog e instruções de instalação.
Registre sua percepção. Isso não prova domínio, não muda sua nota e não bloqueia o próximo tema.