Wprowadzenie do witryny .NET Core Docs

Ten wpis został napisany przez Jeff Sandquist, dyrektor generalny działu Cloud + Enterprise.

Dzisiaj opublikowaliśmy wersję zapoznawcza dokumentacji platformy .NET w witrynie docs.microsoft.com. Aby dowiedzieć się więcej na temat nowych ulepszeń środowiska dokumentacji docs.microsoft.com ofert, odwiedź wprowadzenie docs.microsoft.com wpis w blogu. Oprócz korzystania ze wszystkich funkcji współpracy, zawartości typu open source i bardziej przyjaznych adresów URL dostępnych na platformie docs.microsoft.com wprowadziliśmy kilka nowych funkcji specyficznych dla deweloperów platformy .NET. Ten wpis będzie wyróżniać te nowe funkcje i podsumowywać nasze plany na przyszłość.

Najważniejsze informacje o środowisku dokumentacji platformy .NET

Aby towarzyszyć ekscytującej wersji RTM platformy .NET Core, umieszczamy ją na pierwszej stronie głównej dokumentacji platformy .NET. Aby uzupełnić wersję .NET Core RTM wszystkim, co musisz szybko rozpocząć, umieściliśmy linki do artykułów i nowe środowisko referencyjne w górnej części listy.

Ekosystem platformy .NET na wyciągnięcie ręki

Zobaczysz linki do pobierania nowych bibliotek .NET Core, ASP.NET, Entity Framework, Azure przy użyciu platformy Xamarin do tworzenia aplikacji systemu iOS przy użyciu platformy .NET oraz tworzenia aplikacji platformy uniwersalnej systemu Windows (UWP) przy użyciu platformy .NET. Nie przenieśliśmy jeszcze całej zawartości platformy .NET do docs.microsoft.com, ale strona główna dokumentacji platformy .NET będzie punktem początkowym, aby przejść do całej dokumentacji platformy .NET.

Artykuły

Nasi autorzy i inżynierowie, a także kilku dedykowanych członków społeczności, pracowali niestrudzenie nad tworzeniem nowych artykułów związanych z platformą .NET Core, które znajdziesz w sekcji dokumentacji platformy .NET. W tym miejscu znajdziesz szereg artykułów, takich jak:

• samouczki platformy .NET Core
• wdrażania aplikacji platformy .NET Core
• testowanie jednostkowe na platformie .NET Core

Te i wiele innych tematów są prezentowane w docs.microsoft.com motyw, z czystym spisem treści na każdej stronie, a także szacowanym czasem czytania każdego artykułu i informacji współautora dla każdego artykułu.

Wszystkie artykuły platformy .NET są typu open source i dostępne w witrynie GitHub w repozytorium dokumentacji zespołu platformy .NET . Jeśli znajdziesz jakiekolwiek problemy w dokumentacji lub chcesz je ulepszyć, wystarczy kliknąć przycisk edytować w prawym obszarze nawigacji każdego artykułu.

Edytowanie artykułu jest tak proste, jak kliknięcie przycisku edycji na dowolnym z plików Markdown w repozytorium, dodanie zawartości i przesłanie żądania ściągnięcia. Gdy jeden z naszych zespołów dokona recenzji i zaakceptuje Twoje żądanie ściągnięcia, twoje wkłady będą na żywo w witrynie w ciągu kilku minut.

Dokumentacja interfejsu API

Oprócz doskonałej zawartości tworzonej przez naszych pisarzy, inżynierów i namiętnych członków społeczności wprowadziliśmy znaczące ulepszenia środowiska referencyjnego. Środowisko referencyjne zostało całkowicie przeprojektowane w tej wersji zapoznawczej, pożyczając je na te same zasady projektowania, które zostały użyte w artykułach docs.microsoft.com.

Podobnie jak w tych artykułach, nowe strony referencyjne reagują, zaprojektowane z nowoczesnymi zasadami internetowymi i będą wyglądać lepiej na urządzeniach przenośnych.

Dodaliśmy wyszukiwania typów do wszystkich stron przestrzeni nazw . Dzięki temu można łatwo wyszukiwać według nazwy typu dla wszystkich typów platformy .NET. W przypadku każdej platformy keypress filtrujemy listę typów wyświetlanych w obszarze nawigacji po lewej stronie. Ta ekscytująca nowa funkcja obszaru referencyjnego jest zawarta w naszej nowej strukturze do generowania dokumentacji referencyjnej platformy .NET znanej jako DocFX, projektu open source w witrynie GitHub).

Po kliknięciu poszczególnych typów w obszarze nawigacji po lewej stronie dla dowolnej przestrzeni nazw przeskokniesz bezpośrednio do sekcji wprowadzenia strony przestrzeni nazw do tego typu. Klikając nazwę typu w głównym obszarze zawartości referencyjnej, zobaczysz stronę szczegółów klasy, która zawiera łańcuch dziedziczenia, deklarację i szczegóły dotyczące właściwości i składowych metody klasy.

widok klas

Dla każdego elementu członkowskiego metody zobaczysz szczegółowe informacje na temat parametrów i podsumowania metody.

widok metody

Zasady dotyczące informacji i inżynierii

Oprócz ciągłego opracowywania i ulepszania narzędzi do generowania dokumentów DocFX wprowadziliśmy znaczące ulepszenia zasad inżynierii i dokumentacji, które będą widoczne w nowym środowisku dokumentacji platformy .NET.

better automation

Gdy żądania ściągnięcia są odbierane od potencjalnych współautorów, sprawdzamy, czy współautor postępował zgodnie z prostym procesem podpisywania umowy licencyjnej współautora (ten proces jest w pełni elektroniczny i trwa kilka minut). O ile wkład jest zgodny z wytycznych dotyczących współtworzenia, małe zmiany powinny pojawić się na żywo w ciągu kilku minut po zaakceptowaniu żądań ściągnięcia.

lepsze adresy URL

Jedną z ważnych zasad ogólnego środowiska docs.microsoft.com jest lepsze adresy URL w celu poprawy indeksowania wyszukiwania i "zgadywania". Zachowaliśmy tę zasadę w dokumentacji platformy .NET. Zarówno artykuły, jak i dokumentacja referencyjna mają czystsze adresy URL. Na przykład klasyczny adres URL MSDN dla przestrzeni nazw systemu:

adres URL przestrzeni nazw systemu

W nowej dokumentacji referencyjnej adres URL jest bardziej logiczny, czytelny dla człowieka i co najważniejsze, bardziej wykrywalny.

adres URL przestrzeni nazw systemu

bardziej zwinne i otwarte tworzenie

Zawartość nie tylko jest typu open source i nie tylko akceptujemy współtworzenie społeczności. Ponadto cała zawartość docs.microsoft.com (w tym dokumentacja platformy .NET) jest dostępna w ramach licencji Creative Commons. Możesz go odczytać, skopiować, odwołać się do niego i ponownie użyć ich części (nawet do użytku komercyjnego). Pisarze i inżynierowie aktywnie pracują z członkami społeczności od miesięcy w nowym systemie. To było interesujące i ekscytujące przejście, a my mamy więcej, aby przyjść w przyszłości.

Przyszłe plany

Ta sekcja docs.microsoft.com, podobnie jak reszta witryny, jest nadal dostępna w wersji zapoznawczej, dlatego zachęcamy do konstruktywnych opinii i komentarzy. Prześlij pomysły dotyczące funkcji do usługi UserVoice.

W najbliższych tygodniach opublikujemy komentarze XML używane do generowania dokumentacji referencyjnej bezpośrednio w kodzie źródłowym platformy .NET. Umożliwi to każdemu łatwe kliknięcie aktualizacji dokumentacji referencyjnej programu .NET Framework.
Będziemy również nadal dostosowywać projekt i układ odwołania, a także wyżej wymienioną możliwość edytowania samej zawartości referencyjnej.

Cieszymy się, że udostępnimy ci nowy obszar dokumentacji platformy .NET w docs.microsoft.com i czekamy na lepsze środowisko w przyszłości!