4.3.5 - As APIs publicadas na Vitrine possuem documentação atualizada.
Detalhes do Critério
O que: As APIs que o órgão setorial disponibiliza na Vitrine possuem documentação que está em dia e reflete o funcionamento atual das APIs.
Por que: Uma documentação atualizada é essencial para que desenvolvedores externos ou internos consigam entender e utilizar corretamente as APIs, facilitando a integração e o desenvolvimento de novas soluções.
Onde: Na própria vitrine de APIs, onde a documentação é disponibilizada.
Quando: A atualização da documentação deve ser um processo contínuo, acompanhando as mudanças nas APIs.
Quem: A equipe responsável pela manutenção das APIs e da Vitrine, incluindo a criação e atualização da documentação.
Como: Definindo processos para a criação e atualização da documentação sempre que as APIs forem modificadas.
Quanto: Refere-se à documentação das APIs publicadas.
No comments to display
No comments to display