Slide 22
Slide 22 text
melhores práticas
ESTRUTURA DE
DOCUMENTAÇÃO POR
VERSÃO
DESTAQUE AS
DIFERENÇAS
EXEMPLOS DE
MIGRAÇÃO
INDICADORES DE
OBSOLESCÊNCIA
Organize sua
documentação de
forma que cada
versão da API tenha
sua seção separada.
Forneça uma seção
destacada que
descreva as
principais diferenças
entre as versões.
Se houver mudanças
que afetem a
integração de maneira
significativa, forneça
exemplos claros de
migração da versão
anterior para a nova.
Se uma versão mais
antiga estiver prestes a
ser descontinuada,
destaque essa
informação na
documentação.