Desenvolvimento efetivo de documentação do usuário - curso RUB 22.900. do IBS Training Center, treinamento de 16 horas, data 29 de novembro de 2023.
Miscelânea / / December 02, 2023
Assuntos abordados:
1. Qualidade da documentação.
Tarefas de redação técnica (teoria 60 minutos, prática 20 minutos);
Requisitos de documentação (teoria 50 minutos, prática 20 minutos).
2. Etapas de criação de documentação e tipos de trabalho.
Criação de documentação no âmbito de um projeto de desenvolvimento de software (teoria 30 minutos, prática 20 minutos);
Etapas de desenvolvimento da documentação (teoria 30 minutos);
Tarefa de desenvolvimento de documentação (teoria 15 minutos).
3. Tipos, tipos e estrutura de documentos.
Variedades de documentos técnicos (teoria 30 minutos);
Forma e estrutura do documento, tipos de informação (teoria 40 minutos);
Utilizar cenários (teoria 70 minutos, prática 40 minutos);
Desenvolvimento da parte funcional do documento (teoria 15 minutos);
Desenvolvimento de partes referenciais e descritivas do documento (teoria 15 minutos);
Seção baseada em estrutura (teoria 15 minutos).
4. Desenvolvimento e organização do texto.
Princípios básicos de apresentação (teoria 120 minutos, prática 30 minutos);
Análise de exemplos de textos de baixa qualidade (prática 40 minutos);
Preparação de documentos (teoria 40 minutos);
Diferenças entre documentação russa e inglesa (teoria 40 minutos);
Descrições de elementos específicos (teoria 40 minutos);
Garantir a qualidade da documentação (teoria 40 minutos, prática 30 minutos).
5. Ferramentas e recursos para o redator técnico.
Recomendações para trabalhar com MS Word (teoria 40 minutos, prática 40 minutos);
Recursos online adicionais e ferramentas úteis (teoria 30 minutos).