Wiki'ler, README'ler ve Markdown hakkında

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Ekip projenize zengin biçimlendirme, tablolar ve görüntüler eklemek için Markdown'ı kullanarak ekibinize ve proje katılımcılarınıza destek olabilirsiniz. Markdown biçimi, ekip projesi wiki sayfalarını, panoya eklediğiniz içeriği, takım projenizin README dosyasını ve diğer depoların README dosyalarını iyileştirir.

Tavsiye

Azure DevOps görevlerine yardımcı olması için yapay zekayı kullanabilirsiniz. Başlamak için bkz. Azure DevOps MCP Sunucusu ile yapay zeka yardımlarını etkinleştirme .

Proje wiki'si ayarlama

Ekip projesi wiki'si, projenizle ilgili bilgileri diğer ekip üyeleriyle paylaşmanıza olanak tanır. Sıfırdan bir wiki ayarladığınızda, yeni bir Git deposu Markdown (.md) dosyalarınızı, resimlerinizi, eklerinizi ve sayfa dizinizi depolar. Wiki, içeriğinin ve yapısının işbirliğine dayalı olarak düzenlenmesini destekler.

Aşağıdaki bağlantılarda, bir takım projesi wiki'sinin desteklenen özellikleri açıklanmaktadır.

Yeni wiki oluşturma

Wiki içeriğiyle çalışma

Wiki içeriğini biçimlendirme

Git depolarını wiki'de yayımlama

Birçok ekip, kodlarıyla birlikte depoya iade ettikleri Markdown dosyalarını kullanarak kodlarını belgeler. Git, standart çekme isteği işlemini kullanarak kod belge dosyalarının bakımını ve gözden geçirilmesini desteklese de, bu dosyalar içeriğin tüketicilerine zorluklar sunabilir.

  • Kullanıcıların ilgi çekici içeriği bulmak için genellikle birçok dosya ve klasör arasında eleme yapması gerekir.
  • İçerikte kuruluş ve yapı yok. Okuyucuları destekleyecek doğal bir sayfa hiyerarşisi yoktur.
  • İçerik sürümü oluşturma desteklenmez.
  • İçerikte arama, içerik için iyileştirilmiş bir arama deneyimi yerine kodda arama yapmaktan geçer.

Kodu wiki olarak yayımla özelliğini kullanarak, ekip projenizde tanımlanan bir veya daha fazla Git deposunu wiki'de yayımlayabilirsiniz. Bu özellik, kod belgelerinizi kod tabanınızla zaman uyumlu bir şekilde tutmanın bir yolunu sağlar ve belgelerinizi seçmeli olarak bir wiki'de yayımlamanıza ve güncelleştirmenize olanak tanır.

Bir ekip projesi için wiki'deki içeriği yönetme yönteminiz ile Git deposundan yayımladığınız wiki sayfaları arasında önemli farklar vardır. Ayrıntılar için bkz . Wiki'de Git deposu yayımlama.

Markdown ile proje içeriğini geliştirme

Markdown biçimi, metin biçimlendirmeyi ve resim eklemeyi kolaylaştırır. Ayrıca proje sayfalarınızdaki belgelere, README dosyalarına, panolara ve pull request'lere de bağlanabilirsiniz.

Ekibinize aşağıdaki yollarla rehberlik sağlamak için Markdown'ı kullanın:

Desteklenen söz dizimi için bkz Azure DevOps'ta Markdown kullanma.

Proje README dosyaları ekleyin

Her depo veya ekip projesi için bir README dosyası veya birden çok dosya tanımlayabilirsiniz. README'nizi düz metin yerine Markdown'a yazın. Katkıda bulunanları projenizdeki belirli bilgilere veya konumlara yönlendirmek için BENİOKU sayfalarını kullanın.

Aşağıdaki yönergeleri eklemeyi göz önünde bulundurun:

  • Proje odağı
  • Önkoşullar
  • Ortamı ayarlama
  • Proje içinde iş yapma ipuçları
  • Belirli dosyaların amacı veya kullanımı
  • Projeye özgü terimler ve kısaltmalar
  • Değişiklikleri işleme veya yükleme ve dal ekleme hakkında iş akışı rehberi
  • Proje sponsorları veya ilgili kişiler

README örnekleri

GitHub'daki proje README'lerinin aşağıdaki örnekleri tüm hedef kitleleri referans ve ilham için destekler:

  • Last updated on