Tworzenie aktualizowalnej pomocy: instrukcje krok po kroku

W tych dokumentach wymieniono kroki procesu tworzenia pomocy z aktualizacji.

Tworzenie pomocy zdawanej: krok po kroku

Pomoc, która jest niezmienna, jest przeznaczona dla użytkowników końcowych, ale zapewnia również znaczne korzyści autorom modułów i autorom pomocy, w tym możliwość dodawania zawartości, naprawiania błędów, dostarczania w wielu kulturach interfejsu użytkownika oraz odpowiadania na komentarze i żądania użytkowników, długo po wysłaniu modułu. W tym temacie wyjaśniono, jak spakować i przekazać pliki pomocy, aby użytkownicy mogą je pobierać i instalować przy użyciu polecenia cmdlet Update-Help i Save-Help.

Poniższe kroki zawierają omówienie procesu obsługi pomocy aktualizacji.

Krok 1. Znajdowanie witryny internetowej dla plików pomocy

Pierwszym krokiem tworzenia pomocy, która może być pomocna, jest znalezienie lokalizacji internetowej dla plików pomocy modułu. W rzeczywistości można użyć dwóch różnych lokalizacji. Plik informacji pomocy modułu (Plik XML HelpInfo — opisany poniżej) można przechowywać w jednej lokalizacji internetowej, a pliki CAB zawartości pomocy — w innej lokalizacji internetowej. Wszystkie pliki CAB zawartości pomocy dla modułu muszą znajdować się w tej samej lokalizacji. Pliki CAB zawartości pomocy dla różnych modułów można umieścić w tej samej lokalizacji.

Krok 2. Dodawanie klucza HelpInfoURI do manifestu modułu

Dodaj klucz HelpInfoURI do manifestu modułu. Wartość klucza jest wartością Uniform Resource Identifier (URI) lokalizacji pliku informacji XML HelpInfo dla modułu. Ze względów bezpieczeństwa adres musi zaczynać się od "http" lub "https". Ten adres URI powinien określać lokalizację internetową, ale nie może zawierać nazwy pliku XML HelpInfo.

Na przykład:

@{
RootModule = TestModule.psm1
ModuleVersion = '2.0'
HelpInfoURI = 'https://go.microsoft.com/fwlink/?LinkID=0123'
}

Krok 3. Tworzenie pliku XML HelpInfo

Plik informacji XML HelpInfo zawiera adres URI lokalizacji internetowej plików pomocy oraz numery wersji najnowszych plików pomocy dla modułu w każdej obsługiwanej kulturze interfejsu użytkownika. Każdy Windows PowerShell ma jeden plik XML HelpInfo. Podczas aktualizowania plików pomocy należy edytować lub zastąpić plik XML HelpInfo; Nie dodasz kolejnej. Aby uzyskać więcej informacji, zobacz How to Create a HelpInfo XML File (Jak utworzyć plik XML HelpInfo).

Krok 4. Tworzenie plików CAB

Użyj narzędzia, które tworzy pliki cabinet (), takie jak , w celu utworzenia pliku CAB zawierającego .cab MakeCab.exe pliki pomocy dla modułu. Utwórz oddzielny plik CAB dla plików pomocy w każdej obsługiwanej kulturze interfejsu użytkownika. Aby uzyskać więcej informacji, zobacz How to Prepare Updatable Help CAB Files.

Krok 5. Upload plików

Aby opublikować nowe lub zaktualizowane pliki pomocy, przekaż pliki CAB do lokalizacji internetowej określonej przez element HelpContentUri w pliku XML HelpInfo. Następnie przekaż plik XML HelpInfo do lokalizacji internetowej określonej przez wartość klucza HelpInfoUri w manifeście modułu.