> For the complete documentation index, see [llms.txt](https://redmint.gitbook.io/yard/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://redmint.gitbook.io/yard/master.md).

# Introducción

Yard es una gema que nos permite facilitar la tarea de documentar nuestro proyecto.

Para acceder a más información sobre la gema pueden chequear esto:

<http://yardoc.org/>

<http://yardoc.org/guides/index.html>

Para facilitar la creación de la documentación, yard nos pide que sigamos ciertas reglas a la hora de escribir. Para eso podemos chequear esto

<https://github.com/lsegal/yard/wiki/Tags>