Pengantar wiki proyek Azure DevOps

Selesai

Proyek Azure DevOps menyertakan opsi untuk membuat wiki proyek.

Screenshot of Azure DevOps wiki with title and description example.

Wiki untuk berbagi informasi dengan tim Anda guna memahami dan berkontribusi pada proyek Anda.

Wiki disimpan dalam repositori. Tidak ada wiki yang disediakan secara otomatis.

Prasyarat

Anda harus memiliki izin Membuat Repositori untuk menerbitkan kode sebagai wiki. Meskipun grup Administrator Proyek memiliki izin ini secara default, izin tersebut dapat ditetapkan kepada orang lain.

Untuk menambahkan atau mengedit halaman wiki, Anda harus menjadi anggota grup Kontributor.

Semua anggota proyek tim (termasuk pemangku kepentingan) dapat melihat wiki.

Pembuatan

Artikel berikut mencakup detail pembuatan wiki: Membuat Wiki untuk proyek Anda.

Mengedit wiki

Artikel berikut mencakup detail tentang penerbitan repositori Git ke wiki: Menerbitkan repositori Git ke wiki.

Markdown

Wiki Azure DevOps ditulis dalam Markdown dan juga dapat mencakup lampiran file dan video.

Markdown adalah bahasa markup. Teks biasa termasuk sintaks pemformatan. Ini telah menjadi standar de facto untuk menulis proyek dan dokumentasi perangkat lunak.

Salah satu alasan utama untuk ini adalah karena terdiri dari teks biasa, lebih mudah untuk menggabungkan dengan cara yang sama seperti kode program digabungkan.

Hal ini memungkinkan dokumen untuk dikelola dengan alat yang sama dengan yang digunakan untuk membuat kode lain dalam sebuah proyek.

GitHub Flavored Markdown (GFM)

GFM adalah spesifikasi formal yang dirilis oleh GitHub yang menambahkan ekstensi ke format dasar bernama CommonMark. GFM banyak digunakan baik dalam GitHub maupun secara eksternal. GFM dirender dalam Wiki Azure DevOps.

Mermaid

Mermaid menjadi ekstensi penting untuk Markdown karena memungkinkan diagram untuk dimasukkan dalam dokumentasi.

Ini mengatasi kesulitan penggabungan dokumentasi, termasuk diagram yang diwakili sebagai file biner.

Screenshot of Mermaid Markup showing the welcome to the project wiki Contoso text and graph showing A and B dependencies.

Screenshot of Mermaid Rendering showing the welcome to the project wiki Contoso text and graph showing A and B dependencies.

Detail tentang sintaks Mermaid dapat ditemukan di sini: Pengantar Putri Duyung.