Documentos con diagramas en proyectos github?

Question

Me gustaría escribir un documento de arquitectura para un pequeño proyecto de rubí en el que estoy trabajando, y al ser un documento de arquitectura, se beneficiará de algunos diagramas de caja y barra.

¿Qué se hace en los proyectos de código abierto para esta situación? ¿Debería practicar mi arte ASCII, o debería incluir archivos PDF o algo en mi carpeta de documentos?

Tenga en cuenta que este es un documento independiente, no la documentación API generada a partir del código.

Answer 1

Consulte umlet-github, una extensión de Google Chrome que le permite crear diagramas en UMLet, almacenarlos como archivos UXF en su repositorio y verlos en su navegador dentro de la interfaz de GitHub.

Answer 2

yo diría uso Gliffy, donde se puede exportar diagramas a JPG o PDF y adjuntarlos a su archivo README.md.

También puede obtener un enlace que se puede compartir e incluirlo allí. Muy útil.