Informacje o witrynach typu wiki, readmes i markdown

  • Artykuł

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Aby wspierać twój zespół lub współautorów w projekcie, użyj języka Markdown , aby dodać zaawansowane formatowanie, tabele i obrazy do projektu zespołowego. Możesz użyć formatu Markdown w witrynie typu wiki projektu zespołowego, zawartości dodawanej do pulpitu nawigacyjnego, pliku README projektu zespołowego lub innego pliku README repozytorium.

Witryna Wiki

Używaj witryny typu wiki projektu zespołu, aby udostępniać informacje innym członkom zespołu. Gdy aprowizujesz witrynę typu wiki od podstaw, nowe repozytorium Git zawiera pliki Markdown, obrazy, załączniki i sekwencję stron. Ta witryna typu wiki obsługuje wspólne edytowanie zawartości i struktury.

Następujące funkcje są obsługiwane w witrynie typu wiki projektu zespołowego.

Aprowizuj lub utwórz witrynę typu wiki

Praca z zawartością typu wiki

Uwaga

Funkcja drukowania może nie być dostępna w przeglądarce internetowej Firefox.

Formatowanie zawartości typu wiki

Publikowanie istniejących repozytoriów Git w witrynie typu wiki

Wiele zespołów dokumentuje swój kod przy użyciu języka Markdown i zaewidencjonuje te pliki wraz z kodem. Chociaż usługa Git obsługuje konserwację i przegląd takiej dokumentacji wraz ze standardowymi żądaniami ściągnięcia, takie pliki stanowią kilka wyzwań dla konsumentów zawartości.

  • Czytelnicy muszą często przesiewać wiele plików i folderów, aby znaleźć interesującą zawartość.
  • Zawartość nie ma organizacji i struktury. Nie ma nieodłącznej hierarchii stron do obsługi czytelników.
  • Przechowywanie wersji zawartości nie jest obsługiwane.
  • Wyszukiwanie zawartości polega na wyszukiwaniu kodów, a nie na wyszukiwaniu zoptymalizowanym pod kątem wyszukiwania zawartości.

Za pomocą funkcji publikowania kodu typu wiki możesz opublikować co najmniej jedno repozytorium Git zdefiniowane w projekcie zespołowym w witrynie typu wiki. Ta funkcja umożliwia utrzymywanie zawartości wraz z bazą kodu oraz selektywne publikowanie i aktualizowanie zawartości w witrynie typu wiki.

Istnieją znaczące różnice między sposobem zarządzania zawartością witryny typu wiki aprowizowania projektu zespołowego a stronami typu wiki publikowanymi z repozytorium Git. Aby uzyskać szczegółowe informacje, zobacz Publikowanie repozytorium Git w witrynie typu wiki.

Znaczniki języka Markdown

Język Markdown ułatwia formatowanie tekstu i dołączanie obrazów. Możesz również połączyć się z dokumentami na stronach projektu, plikach README, pulpitach nawigacyjnych i żądaniach ściągnięcia. Możesz podać wskazówki dla zespołu w następujących miejscach przy użyciu języka Markdown:

Aby uzyskać obsługiwaną składnię, zobacz Use Markdown in Azure DevOps (Używanie języka Markdown w usłudze Azure DevOps).

Pliki README

Można zdefiniować plik README lub wiele plików dla każdego repozytorium lub projektu zespołowego. Zapisz plik README w języku Markdown zamiast zwykłego tekstu.

Używaj stron README, aby przekazywać współautorom informacje orientacyjne o pracy w projekcie. Rozważ dodanie następujących wskazówek:

  • Fokus projektu
  • Wymagania wstępne
  • Konfigurowanie środowiska
  • Wskazówki na potrzeby wykonywania zadań w projekcie
  • Cel lub użycie określonych plików
  • Terminy i akronimy specyficzne dla projektu
  • Wskazówki dotyczące przepływu pracy dotyczące zatwierdzania lub przekazywania zmian i dodawania gałęzi
  • Sponsorzy projektu lub kontakty

Oto kilka świetnych readmes, które używają tego formatu i rozmawiają ze wszystkimi odbiorcami w celu uzyskania informacji i inspiracji: