Close

Kategorie

Szablon wytycznych dotyczących tworzenia dokumentacji

autor: Atlassian

Udokumentuj zasady i najlepsze praktyki tworzenia treści w organizacji

Użyj szablonu
Szablon wytycznych dotyczących tworzenia dokumentacji

W związku z rozwojem Twojej organizacji chcesz zapewnić zespołowi opracowującemu treści jedno źródło informacji. Dokumentowanie zasad i wytycznych tworzenia dokumentacji to początek długiego procesu zapewniania zgodności z przepisami. Tu z pomocą przychodzi szablon wytycznych tworzenia dokumentacji: zawiera wszystkie narzędzia konieczne do określenia zasad tworzenia treści oraz koncepcji, na których są oparte, aby umożliwić twórcom w całej organizacji opracowywanie efektywnych i spójnych zasobów.

Jak korzystać z szablonu wytyczne dotyczące tworzenia dokumentacji

Krok 1. Określenie tonu przekazu

Firma włożyła wiele pracy w unikalny głos marki. Dostosowanie go, aby zawsze wypowiadać się odpowiednio do sytuacji, wymaga sporo pracy. Zacznij od opisania typu komunikatu, którego dotyczy dana zasada, następnie określ, jak twórcy treści powinni dostosowywać głos i styl marki pod kątem efektywnego tworzenia komunikatów tego typu. Jeżeli głos Twojej marki ma różne wymiary (w przypadku marki Atlassian jest to odwaga, optymizmi praktyczność oraz poczucie humoru), warto rozważyć dodanie obrazu ilustrującego integrację tych wymiarów w danym typie komunikatu.

Krok 2. Ustalenie zasad (i przedstawienie wykonanej pracy)

Następny krok to określenie zasad tworzenia dokumentacji w ramach tej zasady. Pomyśl o celu osób korzystających z produktu, gdy kierujesz do nich dany komunikat i jakie są ich odczucia w danej chwili. Następnie opracuj 3–5 zasad, które pozwolą wyrazić te cele i emocje. Podaj właściwe i błędne przykłady dla każdej z zasad, aby zilustrować argumenty, i wyjaśnij, dlaczego dany przykład jest prawidłowy lub błędny.

Krok 2. Ustalenie zasad (i przedstawienie wykonanej pracy)

Krok 3. Przekazywanie najbardziej przydatnych wskazówek

Jeżeli opracowujesz zasady tworzenia dokumentacji, prawdopodobnie masz duże doświadczenie w pisaniu przekazów określonego typu. Wykorzystaj je, aby przekazać twórcom treści wskazówki i najlepsze praktyki. Te wskazówki mogą dotyczyć działań, których należy unikać (na przykład „5 najczęstszych pułapek, w które wpadają autorzy treści”), pomysłów dotyczących równoważenia zasad tworzenia tekstów dotyczących konkurencji lub sprawdzonych sposobów kreatywnego działania. Można nawet dodać łącze do badań lub zasobów zewnętrznych w celu poszerzenia kontekstu.


Atlassian to producent oprogramowania dla przedsiębiorstw oferujący produkty dla deweloperów, menedżerów projektów oraz do zarządzania zawartością.

  • Content design glossary template

    Atlassian

    Content design glossary

    Teach writers how to use product names, industry terms, and other content with an A-Z guide.

    Użyj szablonu Dowiedz się więcej
  • Content strategy template

    Atlassian

    Strategia dotycząca treści

    Utwórz plan strategii dotyczącej treści i uporządkuj swój kalendarz redakcyjny.

    Użyj szablonu Dowiedz się więcej
  • Customer interview report template

    Atlassian

    Raport z rozmowy z klientem

    Zamień rozmowy z klientem we wnikliwe analizy, korzystając z raportu z rozmowy z klientem.

    Użyj szablonu Dowiedz się więcej