Udostępnij za pomocą

Współtworzenie dokumentacji programu PowerShell

Dziękujemy za pomoc techniczną programu PowerShell!

Przewodnik współautora to zbiór artykułów opisujących narzędzia i procesy używane do tworzenia dokumentacji w firmie Microsoft. Niektóre z tych przewodników zawierają informacje wspólne dla każdego zestawu dokumentacji opublikowanego do learn.microsoft.com. Inne przewodniki dotyczą sposobu pisania dokumentacji programu PowerShell.

Typowe artykuły są dostępne w scentralizowanym Przewodniku dla Współautorów . Przewodniki specyficzne dla programu PowerShell są dostępne tutaj.

Sposoby współtworzenia

Istnieją dwa sposoby, aby się przyczynić. Oba wkłady są dla nas cenne.

  • Zgłaszanie problemów pomaga nam w identyfikacji problemów i luk w naszej dokumentacji. Czasami problemy są trudne do rozwiązania, wymagając większej liczby badań i badań. Proces problemu umożliwia nam konwersację na temat problemu i opracowanie zadowalającego rozwiązania.

  • Przesyłanie pull requesta w celu dodania lub zmiany zawartości jest bardziej skomplikowanym procesem. Poniższe informacje przedstawiają narzędzia, procesy i standardy przesyłania zawartości do dokumentacji.

Przygotuj się do wniesienia wkładu

Współtworzenia dokumentacji wymaga konta usługi GitHub. Użyj poniższej listy kontrolnej, aby zainstalować i skonfigurować narzędzia potrzebne do współtworzenia.

  1. Zarejestruj się w usłudze GitHub
  2. Instalowanie narzędzi Git i Markdown
  3. Instalowanie pakietu Docs Authoring Pack
  4. Zainstalować Posh-Git — nie jest to wymagane, ale zalecane
  5. Konfigurowanie lokalnego repozytorium Git
  6. Przeglądanie podstaw usług Git i GitHub

Rozpocznij pisanie dokumentacji

Istnieją dwa sposoby współtworzenia zmian w dokumentacji:

  1. szybkie edycje istniejących dokumentów — drobne poprawki, naprawianie literówek lub drobnych dodatków
  2. pełny przepływ pracy usługi GitHub dla dokumentów — duże zmiany, wiele wersji, dodawanie lub zmienianie obrazów lub współtworzenia nowych artykułów

Przeczytaj również sekcję Podstawy pisania w scentralizowanym przewodniku dla współautorów. Innym doskonałym zasobem jest Microsoft Writing Style Guide.

Drobne poprawki lub wyjaśnienia dotyczące dokumentacji i przykładów kodu w repozytoriach publicznych są objęte learn.microsoft.com Warunki użytkowania.

Użyj pełnego przepływu pracy usługi GitHub podczas wprowadzania znaczących zmian. Jeśli nie jesteś pracownikiem firmy Microsoft, nasz system weryfikacji dodaje komentarz do żądania ściągnięcia, abyś podpisał Umowę Licencyjną dla Wkładu (CLA) przez internet . Aby móc przejrzeć lub zaakceptować żądanie ściągnięcia, musisz wykonać ten krok. Podpisanie umowy CLA jest wymagane tylko przy pierwszym przesłaniu pull requestu w repozytorium. Może być wymagane podpisanie CLA za każdym razem, gdy wnosisz wkład do nowego repozytorium.

Kodeks postępowania

Wszystkie repozytoria, które publikują do Microsoft Learn, są zgodne z Microsoft Open Source Code of Conduct lub kodeksem postępowania .NET Foundation. Aby uzyskać więcej informacji, zobacz Kodeks postępowania — często zadawane pytania.

Następne kroki

Poniższe artykuły zawierają informacje specyficzne dla dokumentacji programu PowerShell. W przypadku nakładania się wskazówek w scentralizowanym przewodniku współautora objaśniamy różnice tych reguł dla zawartości programu PowerShell.

Przejrzyj następujące dokumenty:

Dodatkowe zasoby

  • Last updated on