Enable javascript in your browser for better experience. Need to know to enable it? Go here.

Quadrantes de documentação

Publicado : Mar 29, 2022
NÃO ENTROU NA EDIÇÃO ATUAL
Este blip não está na edição atual do Radar. Se esteve em uma das últimas edições, é provável que ainda seja relevante. Se o blip for mais antigo, pode não ser mais relevante e nossa avaliação pode ser diferente hoje. Infelizmente, não conseguimos revisar continuamente todos os blips de edições anteriores do Radar. Saiba mais
Mar 2022
Experimente ?

Escrever uma boa documentação é um aspecto negligenciado do desenvolvimento de software, muitas vezes sendo deixado para o último minuto e executado de forma casual. Alguns de nossos times encontraram nos quadrantes de documentação uma maneira prática de garantir que os artefatos corretos estejam sendo produzidos. Essa técnica classifica os artefatos em dois eixos: o primeiro eixo diz respeito à natureza da informação — prática ou teórica; o segundo eixo descreve o contexto em que os artefatos são usados — estudo ou trabalho. Dessa forma, são definidos quatro quadrantes nos quais artefatos como tutoriais, guias de instruções ou páginas de referência podem ser colocados e compreendidos. Esse sistema de classificação não apenas garante que artefatos críticos não sejam esquecidos, mas também orienta a apresentação do conteúdo. Achamos essa técnica particularmente útil para criar documentação de onboarding e acelerar a integração de pessoas desenvolvedoras em um novo time.

Baixe o PDF

 

 

 

English | Español | Português | 中文

Inscreva-se para receber o boletim informativo Technology Radar

 

 

Seja assinante

 

 

Visite nosso arquivo para acessar os volumes anteriores