Documentação externa para PHP, sem documento de documento
-
21-09-2019 - |
Pergunta
Preciso de um sistema de documentação para um projeto PHP e queria que ele fosse capaz de integrar documentação externa (casos de uso, escopo do projeto etc.) com a documentação gerada nos comentários do código. Parece que o PhpDocumentor tem exatamente o conjunto de recursos certo, mas a documentação externa deve ser escrita no DocBook, que é muito complexa para a nossa equipe.
Se estivesse em Python, a Esfinge seria perfeita para esse trabalho (o descanso é definitivamente mais simples que o DocBook). Existe alguma maneira de integrar a documentação de repouso externo com os documentos extraídos do PHPDOC? Devo apenas separar a documentação externa (por exemplo, use REST para externo e phpDoc para interno)? Ou você tem uma sugestão melhor para gerenciar a documentação externa?
Solução
Você pode converter REST em DocBook usando Pandoc.
Outras dicas
Converta as postagens do WordPress no estilo DocBook. Aqui está a amostra.
http://hashfold.com/techfold/wordpress-how-to-generate-docbook-stylepospos/