Eu sou o autor do pg_message_queue, que é um sistema de canal / fila muito leve no PostgreSQL projetado para facilitar a integração em nível de banco de dados. As mensagens podem então ser encaminhadas para uma fila de mensagens mais pesada, ou algo semelhante, ou podem ser processadas. O caso de uso é para coisas como "Eu quero enviar um e-mail do banco de dados" e ajuda a resolver o problema do PostgreSQL sem problemas de processamento transacional que podem resultar.
Nossa documentação está no link
Eu não direi que é a melhor documentação disponível, mas é suficiente para nosso caso de uso. Compare ao link que é a documentação do rabbitmq e você verá como os requisitos da documentação são diferentes.
Mas, como todos os documentos, mantenha seu público-alvo e use o caso em mente e passe por isso conceitualmente e de forma programática.
Editar Ok, vejo o que entendi errado. Eu sugiro começar pelo menos com um esboço de documentação técnica. Se você tem de outra pessoa, ótimo. Se não, pelo menos, elabore um resumo do que um manual de programador técnico deve cobrir.
Parece-me que você está procurando documentar um protocolo de rede em vez de uma API. Desculpe, eu li e perdi essa parte. Ainda não está claro para mim se isso é direto sobre TCP, ou sobre HTTP, ou outra coisa. Na medida em que você está reutilizando outros protocolos, o trabalho é mais fácil.
De qualquer forma, eu dividiria a documentação em três seções. O primeiro cobriria a estrutura da mensagem em geral. Isso incluiria cabeçalhos, especificações do corpo da mensagem etc., mas estaria em um nível geral suficiente para fornecer uma referência para a seção 2.
A seção 2 cobriria as especificidades de cada tipo de mensagem. Mais uma vez, depende do que exatamente você está reutilizando a profundidade que você precisa para entrar.
A Seção 3 forneceria exemplos de como a comunicação funcionaria usando conjuntos de mensagens simuladas.