troubleshooting article preview template

Szablon Artykuł na temat rozwiązywania problemów

Utworzone przez:

Atlassian logo

To narzędzie, które pozwoli Ci udokumentować częste problemy oraz ich rozwiązania

Kategorie

  • Oprogramowanie i IT

NAJWAŻNIEJSZE FUNKCJE

  • Rozwiązywanie problemów

  • Dokumentacja

  • Baza wiedzy

troubleshooting article preview template

Tworzenie artykułów dotyczących rozwiązywania problemów może pomóc klientom uporać się z częstymi problemami i znaleźć własne rozwiązania. Nasz szablon artykułu na temat rozwiązywania problemów tworzy strukturę, na bazie której można sformułować problem, szczegółowo opisać jego rozwiązanie oraz wyświetlić artykuły powiązane (można to zrobić automatycznie za pomocą etykiet oraz makra do wyświetlania zawartości według etykiet, aby móc śledzić powiązane artykuły). Naucz użytkowników wyszukiwania rozwiązań i daj swojemu zespołowi odpowiedzialnemu za wsparcie więcej czasu na uporanie się z bardziej złożonymi zadaniami.

Jak korzystać z szablonu artykułu na temat rozwiązywania problemów

  1. 1

    Opisanie problemu

    W przypadku tego rodzaju artykułów przejście wprost do rozwiązania wydaje się kuszące, jednak opis problemu to niezwykle ważna część tworzenia skutecznej treści. Czytelnicy muszą być w stanie stwierdzić, czy Twój artykuł dotyczy napotkanych przez nich problemów. Zastanów się, jak Twoi użytkownicy odbierają problem i objaśnij go przy użyciu terminologii i przykładów właściwych dla ich sytuacji.

  2. 2

    Przedstawienie rozwiązania krok po kroku

    Po opisaniu problemu trzeba objaśnić, w jaki sposób go rozwiązać. Zapisz rozwiązanie krok po kroku w formie listy numerowanej. Używaj pojęć znanych czytelnikom i dla nich zrozumiałych. Skup się na każdym kroku z osobna. W miarę możliwości zilustruj kroki obrazkami. W ten sposób czytelnicy artykułu będą wiedzieć, jaki efekt powinni uzyskać na poszczególnych etapach. Jeśli dostępne jest więcej niż jedno rozwiązanie, najlepiej przyjąć to, które sprawdza się najczęściej. Jeśli czujesz, że musisz zamieścić więcej opcji, możesz użyć funkcji rozwijania, aby utworzyć zwijany panel, w którym znajdą się inne rozwiązania.

  3. 3

    Wyświetlenie powiązanych artykułów

    Czasami użytkownik trafia na artykuł dotyczący problemu podobnego do tego, z którym się obecnie boryka, ale nie takiego samego. A czasami więcej informacji na temat sposobu działania jakiegoś procesu może pomóc uniknąć problemów na przyszłość. Jeśli dodasz etykiety do swoich artykułów na temat rozwiązywania problemów i wykorzystasz makro wyświetlania treści według etykiety (dostępne już w tym szablonie), będzie można automatycznie wyświetlać powiązane artykuły i strony. Wystarczy pamiętać o zastosowaniu tej samej etykiety do wszystkich powiązanych stron.

Powiązane szablony

Partnerzy

Schemat architektury AWS

Zwizualizuj swoją infrastrukturę, aby móc lepiej rozpoznać słabości i wskazać miejsca wymagające ulepszenia.

Dokumenty i raporty

Planowanie idealnego tygodnia pracy

Zapewnij szczegółowe wskazówki na temat wykonywania zadania.

Zalecane

Wykaz procedur DevOps

Przygotuj zespół operacyjny do szybkiego reagowania na alerty i przestoje.