Introduzione ai wiki di progetto di Azure DevOps

Completato

Azure DevOps Projects include un'opzione per creare un wiki di progetto.

Project wiki

Wiki per condividere informazioni con il team per comprendere e contribuire al progetto.

I wiki vengono archiviati in un repository. Di nessun wiki viene eseguito automaticamente il provisioning.

Prerequisiti

È necessario avere l'autorizzazione Crea un repository per pubblicare il codice come wiki. Anche se il gruppo Project Administrators ha questa autorizzazione per impostazione predefinita, può essere assegnata ad altri.

Per aggiungere o modificare pagine wiki, è necessario essere un membro del gruppo Collaboratori.

Tutti i membri del progetto team, incluse le parti interessate, possono visualizzare il wiki.

Creazione

L'articolo seguente include informazioni dettagliate sulla creazione di un wiki: Creare un wiki per il progetto.

Modifica del wiki

L'articolo seguente include informazioni dettagliate sulla pubblicazione di un repository Git in un wiki: Pubblicare un repository Git in un wiki.

Markdown

I wiki di Azure DevOps sono scritti in Markdown e possono includere anche file allegati e video.

Markdown è un linguaggio di markup. Il testo normale include la sintassi di formattazione. È diventato lo standard de facto per il modo in cui è ora scritta la documentazione del progetto e del software.

Una delle ragioni principali di ciò è che, essendo costituito da testo normale, è molto più facile da unire nello stesso modo in cui viene unito il codice del programma.

Consente di gestire i documenti con gli stessi strumenti usati per creare altro codice in un progetto.

GitHub Flavored Markdown (GFM)

GFM è una specifica formale rilasciata da GitHub che ha aggiunto estensioni a un formato di base chiamato CommonMark. GFM è ampiamente usato sia all'interno di GitHub che esternamente. Il rendering di GFM viene eseguito nei wiki di Azure DevOps.

Mermaid

Mermaid è diventato un'estensione essenziale di Markdown perché consente di includere diagrammi nella documentazione.

Supera le precedenti difficoltà nell'unione della documentazione che include diagrammi rappresentati come file binari.

Mermaid Markup

Mermaid Rendering

I dettagli sulla sintassi Mermaid sono disponibili qui: Mermaid Introduction