Introducción a wikis de proyecto de Azure DevOps

Completado

Azure DevOps Projects incluye una opción para crear una wiki de proyecto.

Project wiki

Wiki para compartir información con su equipo, reconocer el proyecto y contribuir a él.

Las wikis se almacenan en un repositorio. Ninguna wiki se aprovisiona automáticamente.

Requisitos previos

Debe tener permiso para Crear un repositorio y publicar el código como wiki. Aunque el grupo de Administradores del proyecto tengan este permiso de forma predeterminada, se puede asignar a otros usuarios.

Para agregar o editar páginas wiki, debe ser miembro del grupo Colaboradores.

Todos los miembros del proyecto de equipo (incluidas las partes interesadas) pueden ver la wiki.

Creación

En el siguiente artículo se incluyen detalles sobre la creación de una wiki: Creación de una wiki para el proyecto.

Edición de la wiki

En el siguiente artículo se incluyen detalles sobre cómo publicar un repositorio de Git en una wiki: Publicación de un repositorio de Git en una wiki.

Markdown

Las wikis de Azure DevOps se escriben en Markdown y también pueden incluir archivos adjuntos y vídeos.

Markdown es un lenguaje de marcado. El texto sin formato incluye la sintaxis de formato. Se ha convertido en el estándar de facto para la forma en que se escribe ahora la documentación del proyecto y el software.

Una razón clave para esto es que, dado que está hecho de texto sin formato, es mucho más fácil combinar de la misma manera que se combina el código del programa.

Permite gestionar los documentos con las mismas herramientas que se utilizan para crear otros códigos en un proyecto.

GitHub Flavored Markdown (GFM)

GFM es una especificación formal publicada por GitHub que agregó extensiones a un formato base denominado CommonMark. GFM se usa ampliamente en GitHub y de manera externa. GFM se representa en las wikis de Azure DevOps.

Mermaid

Mermaid se ha convertido en una extensión esencial de Markdown porque permite incluir diagramas en la documentación.

Supera las dificultades anteriores a la hora de combinar documentación que incluye diagramas representados como archivos binarios.

Mermaid Markup

Mermaid Rendering

Aquí puede encontrar más información sobre la sintaxis de Mermaid: Introducción a Mermaid