Writing guidelines template preview screenshot

Szablon wytyczne dotyczące tworzenia dokumentacji

Utworzone przez:

Atlassian logo

Udokumentuj zasady i najlepsze praktyki tworzenia treści w organizacji

Kategorie

  • Projekt

NAJWAŻNIEJSZE FUNKCJE

  • Zarządzanie treściami

  • Zasób

  • Dokumentacja

Writing guidelines template preview screenshot

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 wytycznych dotyczących tworzenia dokumentacji

  1. 1

    Określenie tonu przekazu

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

  2. 2

    Ustalenie zasad (i przedstawienie wykonanej pracy)

    Następny krok to określenie zasad tworzenia dokumentacji w ramach tego wzorca. Pomyśl o celach osób korzystających z produktu, gdy otrzymują tego typu komunikat, i o ich odczuciach w tamtej chwili. Następnie opracuj 3–5 zasad, które pozwolą wyrazić te cele i emocje. Podaj pozytywne i negatywne przykłady dla każdej z zasad, aby zilustrować argumenty, i wyjaśnij, dlaczego dany przykład jest pozytywny lub negatywny.

  3. 3

    Przekazanie 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.

Powiązane szablony

Projekt

Słownik na potrzeby tworzenia treści

Naucz autorów tekstów korzystania z nazw produktów, pojęć branżowych oraz innych treści dzięki przewodnikowi od A do Z.

Projekt

Strategia dotycząca treści

Nakreśl strategię dotyczącą treści i uporządkuj kalendarz redakcyjny

Zarządzanie produktem

Raport z rozmowy z klientem

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