Criação de um manual com mais ou menos a seguinte estrutura:
Introduction
introduz conceitos do CPI
explica para que ele foi criado
define terminologia utilizada
DocMap
Tutorial (ou Example)
demonstra como fazer uso completo de uma gateway, desde pagamento, até notificações e queries
pode ser dividido em mais de uma parte, como o tutorial de Catalyst
Gateway
documenta em detalhes o que é uma gateway do CPI (mais do que Business::CPI::Gateway::Base)
explica todos os métodos padrões, e padrões de nomes customizados por gateways
Contributing
como contribuir com documentação
como contribuir com código (padrões, comunidade, etc)
Contributing::NewGateway
como contribuir com uma nova gateway
entra em mais detalhes do que o manual de gateway com relação à codificação interna, quais métodos devem ser definidos e como
definir o que pode ser customizado por cada gateway
FAQ
Cookbook
Toda a documentação deveria estar disponível em inglês a princípio, mas ser traduzida para o português utilizando a estrutura POD2::PT_BR. Tanto a versão em inglês como em português podem estar incluídas na própria distribuição principal (pelo menos a princípio).
Criação de um manual com mais ou menos a seguinte estrutura:
Toda a documentação deveria estar disponível em inglês a princípio, mas ser traduzida para o português utilizando a estrutura POD2::PT_BR. Tanto a versão em inglês como em português podem estar incluídas na própria distribuição principal (pelo menos a princípio).