Jak korzystać z dokumentacji

Ten artykuł zawiera zasoby i porady dotyczące korzystania z biblioteki dokumentacji programu Microsoft Endpoint Manager. Ma zastosowanie do programu Configuration Manager, usługi Microsoft Intune i rozwiązania Autopilot i obejmuje następujące obszary:

  • Jak wyszukiwać
  • Przesyłanie informacji o błędach dokumentów, ulepszeń, pytań i nowych pomysłów
  • Jak otrzymywać powiadomienia o zmianach
  • Jak współtworzyć dokumentację

Aby uzyskać ogólną pomoc i wsparcie techniczne, zobacz:

Porada

Skorzystaj również z węzła Dokumentacja w obszarze roboczym Społeczność w konsoli programu Configuration Manager. Ten węzeł zawiera aktualne informacje dotyczące dokumentacji programu Configuration Manager i artykułów pomocy technicznej. Aby uzyskać więcej informacji, zobacz Używanie konsoli programu Configuration Manager.

Informacje zawarte w tym artykule dotyczą również dokumentacji programu PowerShell dla programu Configuration Manager w repozytorium sccm-docs-powershell-ref repository.

Poniższe porady dotyczące wyszukiwania ułatwiają znajdowanie potrzebnych informacji:

  • Wyszukując zawartość przy użyciu ulubionego aparatu wyszukiwania, uwzględnij słowo kluczowe wraz z kluczowymi słowami wyszukiwania. Na przykład ConfigMgr dla programu Configuration Manager i Intune dla usługi Intune.

    • Wyszukaj wyniki z witryny docs.microsoft.com/mem. Wyniki z witryn docs.microsoft.com/previous-versions, technet.microsoft.com i msdn.microsoft.com dotyczą starszych wersji produktów.

    • Aby jeszcze bardziej zawęzić wyniki wyszukiwania do bieżącej biblioteki zawartości, w zapytaniu dołącz ciąg site:docs.microsoft.com, aby określić zakres aparatu wyszukiwania.

  • Używaj terminów wyszukiwania, które są zgodne z terminologią stosowaną w interfejsie użytkownika i dokumentacji online. Unikaj nieoficjalnych terminów lub skrótów, które mogą być widoczne w treściach społeczności. Wyszukaj na przykład tekst:

    • „punkt zarządzania” zamiast „PZ”
    • „typ wdrożenia” zamiast „TW”
    • „rozszerzenie do zarządzania usługi Intune” zamiast „IME”
  • Aby wyszukać w bieżącym artykule, użyj funkcji Znajdź przeglądarki. W większości nowoczesnych przeglądarek internetowych możesz nacisnąć klawisze Ctrl+F, a następnie wprowadzić wyszukiwane terminy.

  • Każdy artykuł w witrynie docs.microsoft.com zawiera następujące pola, które ułatwiają wyszukiwanie zawartości:

    • Pole Wyszukaj w prawym górnym rogu. Aby wyszukać we wszystkich artykułach, wprowadź terminy w tym polu. Artykuły w tej bibliotece zawartości automatycznie zawierają jeden z następujących zakresów wyszukiwania: ConfigMgr lub Intune.

      Pole wyszukiwania dokumentów w nagłówku

    • Pole Filtruj według tytułu powyżej spisu treści po lewej stronie. Aby wyszukać w bieżącym spisie treści, wprowadź terminy w tym polu. To pole dopasowuje tylko te terminy, które pojawiają się w tytułach artykułów dla bieżącego węzła. Na przykład Infrastruktura podstawowa programu Configuration Manager (docs.microsoft.com/mem/configmgr/core) lub Aplikacje usługi Intune (https://docs.microsoft.com/mem/intune/apps/). Ostatni element w wynikach wyszukiwania udostępnia opcję wyszukania terminów w całej bibliotece zawartości.

      Animacja przedstawiająca użycie tabeli filtru spisu treści

Masz problemy ze znalezieniem czegoś? Prześlij opinię! Podczas zgłaszania problemu dotyczącego wyników wyszukiwania podaj informacje o używanym aparacie wyszukiwania, słowach kluczowych i artykule docelowym. Ta opinia pomoże firmie Microsoft zoptymalizować zawartość w celu lepszego wyszukiwania.

Dodawanie wyszukiwarki niestandardowej

W przypadku wielu nowoczesnych przeglądarek internetowych można utworzyć wyszukiwarkę niestandardową. Ta funkcja pozwala na szybkie i łatwe przeszukiwanie witryny docs.microsoft.com. Na przykład w programie Microsoft Edge w wersji 77 i nowszych wykonaj kroki następującego procesu:

  1. W programie Microsoft Edge w wersji 77 lub nowszej otwórz obszar Ustawienia.

  2. W menu po lewej stronie wybierz pozycję Prywatność, wyszukiwanie i usługi.

  3. Przewiń do dołu grupy Usługi, a następnie wybierz pozycję Pasek adresu i wyszukiwanie.

  4. Wybierz pozycję Zarządzaj wyszukiwarkami.

  5. Wybierz pozycję Dodaj i podaj następujące informacje:

    • Wyszukiwarka: wprowadź przyjazną nazwę, aby zidentyfikować wyszukiwarkę na liście. Na przykład Microsoft docs.

    • Słowo kluczowe: podaj krótki termin, który ma być używany na pasku adresu w celu aktywowania danej wyszukiwarki. Na przykład memdocs.

    • Adres URL z elementem %s w miejscu zapytania: Przykład:

      https://docs.microsoft.com/en-us/search/index?search=%s&scope=ConfigMgr
      

      Uwaga

      Ten przykład jest specyficzny dla zakresu ConfigMgr. Można usunąć zmienną zakresu, aby przeszukać całą witrynę docs.microsoft.com, lub użyć innego zakresu.

      Wyszukiwarka Microsoft Docs wymaga, aby adres zawierał ustawienia regionalne. Na przykład en-us. Możesz zmienić wpis, aby użyć innych ustawień regionalnych.

    Dodawanie do przeglądarki Microsoft Edge wyszukiwarki niestandardowej na potrzeby witryny Microsoft Docs

Po dodaniu tej wyszukiwarki wpisz słowo kluczowe na pasku adresu przeglądarki, naciśnij klawisz Tab, a następnie wpisz terminy wyszukiwania i naciśnij klawisz Enter. Spowoduje to automatyczne wyszukanie wybranych terminów w witrynie Microsoft Docs przy użyciu zdefiniowanego zakresu.

Opinie

Wybierz link Opinie w prawym górnym rogu dowolnego artykułu, aby przejść do sekcji Opinie znajdującej się na dole. Opinie są zintegrowane z problemami usługi GitHub. Aby uzyskać więcej informacji na temat integracji z problemami usługi GitHub, zobacz ten wpis w blogu dotyczący platformy dokumentacji.

Zrzut ekranu przedstawiający sekcję opinii w artykule dokumentacji

Aby udostępnić opinię, która nie dotyczy dokumentacji, tylko samego produktu, wybierz pozycję Ten produkt. Ta akcja spowoduje otwarcie witryny UserVoice dla danego produktu.

Aby udostępnić opinię dotyczącą bieżącego artykułu, wybierz pozycję Ta strona. Aby przekazać opinię dotyczącą dokumentacji, trzeba mieć konto usługi GitHub. Po zalogowaniu wymagana jest jednorazowa autoryzacja dla organizacji MicrosoftDocs. Następnie zostanie otwarty formularz nowego problemu w usłudze GitHub. Dodaj opisowy tytuł i szczegółową opinię w treści, ale nie modyfikuj sekcji szczegółów dokumentu. Następnie wybierz pozycję Submit new issue (Prześlij nowy problem), aby zgłosić nowy problem dotyczący artykułu docelowego w repozytorium MEMDocs GitHub.

Aby sprawdzić, czy istnieje już opinia dotycząca tego artykułu, wybierz pozycję View all page feedback (Wyświetl wszystkie opinie dotyczące strony). Ta akcja spowoduje otwarcie zapytania dotyczącego problemu w usłudze GitHub dla tego artykułu. Domyślnie są wyświetlane zarówno problemy otwarte, jak i zamknięte. Przed przesłaniem nowego problemu zapoznaj się z istniejącymi opiniami. W przypadku znalezienia podobnego problemu wybierz ikonę twarzy, aby dodać reakcję, dodać komentarz do wątku lub zasubskrybować, aby otrzymywać powiadomienia.

Typy opinii

Używając opcji problemów usługi GitHub, możesz przesłać następujące typy opinii:

  • Usterka dokumentu: Zawartość jest nieaktualna, niejasna, myląca lub uszkodzona.
  • Ulepszenie dokumentu: Sugestia dotycząca ulepszenia artykułu.
  • Pytanie dotyczące dokumentu: Potrzebujesz pomocy w znalezieniu istniejącej dokumentacji.
  • Pomysł dotyczący dokumentu: Sugestia dotycząca nowego artykułu. Użyj tej metody zamiast witryny UserVoice na potrzeby opinii dotyczącej dokumentacji.
  • Pochwała: Pozytywna opinia dotycząca przydatnego lub pouczającego artykułu.
  • Lokalizacja: Opinie dotyczące tłumaczenia zawartości.
  • Optymalizacja aparatu wyszukiwania (SEO): Opinia dotycząca problemów z wyszukiwaniem zawartości. W komentarzach dołącz informacje o aparacie wyszukiwania, słowach kluczowych i artykule docelowym.

Jeśli utworzysz problem niezwiązany z dokumentacją, firma Microsoft zamknie ten problem i przekieruje Cię do lepszego kanału opinii. Przykład:

Aby podzielić się opinią o podstawowej platformie docs.microsoft.com, zobacz Opinie dotyczące dokumentacji. Platforma obejmuje wszystkie składniki otoki, takie jak nagłówek, spis treści i menu po prawej stronie. Uwzględnia również elementy renderowania artykułów w przeglądarce, takie jak czcionka, pola alertów i kotwice strony.

Powiadomienia

Aby otrzymywać powiadomienia o zmianach zawartości w bibliotece dokumentacji, wykonaj następujące czynności:

  1. Użyj funkcji wyszukiwania dokumentacji, aby znaleźć artykuł lub zestaw artykułów. Przykład:

    • Wyszukaj pojedynczy artykuł według tytułu, „Co nowego w usłudze Microsoft Intune — Azure”

      Porada

      Aby zawęzić wyszukiwanie pojedynczego artykułu do jednego artykułu, użyj pełnego tytułu, który jest wyświetlany w wynikach wyszukiwania w witrynie docs.microsoft.com. Ten tytuł jest wyświetlany na karcie przeglądarki.

    • Wyszukiwanie dowolnego artykułu programu Configuration Manager dotyczącego funkcji BitLocker

  2. W dolnej części listy wyników wybierz link RSS.

    Zrzut ekranu przedstawiający wyniki wyszukiwania i link RSS

  3. Użyj tego kanału informacyjnego w dowolnej aplikacji RSS, aby otrzymywać powiadomienia w przypadku zmiany dowolnego z wyników wyszukiwania.

W kilku popularnych artykułach w tej bibliotece zawartości u góry znajduje się porada z gotowym linkiem do kanału informacyjnego RSS.

Porada

Możesz również obserwować repozytorium MEMDocs w witrynie GitHub. Ta metoda może generować wiele powiadomień. Nie obejmuje również zmian z prywatnego repozytorium używanego przez firmę Microsoft.

Współtworzenie

Biblioteka dokumentacji programu Microsoft Endpoint Manager, tak jak większość zawartości w witrynie docs.microsoft.com, jest typu open-source w serwisie GitHub. Ta biblioteka akceptuje wkład społeczności i zachęca do niego. Aby uzyskać więcej informacji o tym,jak rozpocząć pracę, zobacz Przewodnik współautora. Jedynym wymaganiem wstępnym jest utworzenie konta w usłudze GitHub.

Podstawowe kroki współtworzenia

  1. W artykule docelowym wybierz pozycję Edytuj w prawym górnym rogu. Ta akcja powoduje otwarcie pliku źródłowego w usłudze GitHub.

  2. Aby edytować plik źródłowy, wybierz ikonę ołówka.

    Zrzut ekranu przedstawiający nagłówek pliku źródłowego w usłudze GitHub

  3. Wprowadź zmiany w źródłowym pliku Markdown. Aby uzyskać więcej informacji, zobacz Jak używać języka Markdown do pisania dokumentów.

  4. W sekcji Propose file change (Zaproponuj zmianę pliku) wprowadź komentarz zatwierdzenia publicznego z opisem zmiany. Następnie wybierz pozycję Propose file change (Zaproponuj zmianę pliku).

  5. Przewiń w dół i sprawdź wprowadzone zmiany. Wybierz pozycję Utwórz żądanie ściągnięcia, aby otworzyć formularz. Opisz, dlaczego zmiana została wprowadzona. Wybierz pozycję Utwórz żądanie ściągnięcia.

Zespół zajmujący się pisaniem artykułów otrzyma Twoje żądanie ściągnięcia i przypisze je do odpowiedniej osoby piszącej. Autor zapozna się z tekstem i przeprowadzi szybką ocenę edycji. Następnie zatwierdzi i scali zmiany lub skontaktuje się z Tobą, aby uzyskać więcej informacji o aktualizacji.

Co można współtworzyć

Jeśli chcesz współtworzyć, ale nie wiesz, od czego zacząć, zapoznaj się z poniższymi sugestiami:

  • Przejrzyj artykuł pod kątem dokładności. Następnie zaktualizuj metadane ms.date, używając formatu mm/dd/yyyy. Taki wkład pomaga zachować aktualność zawartości.

  • Dodaj wyjaśnienia, przykłady lub wskazówki w oparciu o swoje doświadczenie. Taki wkład umożliwia społeczności dzielenie się wiedzą.

  • Popraw tłumaczenie w języku innym niż angielski. Taki wkład zwiększa użyteczność zlokalizowanej zawartości.

  • Przeszukaj listę problemów dotyczących etykiet przeznaczonych dla społeczności:

Uwaga

Współtworzenie w większym zakresie wymaga podpisania Umowy licencyjnej udziału (CLA, Contribution License Agreement), jeśli nie jesteś pracownikiem firmy Microsoft. Usługa GitHub automatycznie wymaga podpisania tej umowy, gdy wkład przekroczy wartość progową. Tę umowę wystarczy podpisać raz.

Porady dotyczące współtworzenia

Postępuj zgodnie z poniższymi ogólnymi wskazówkami dotyczącymi współtworzenia:

(Ta lista została pobrana z przewodnika współtworzenia platformy .NET).