Być zorganizowanym! Jak stworzyć przewodnik po stylu bazy wiedzy

Pisanie bazy wiedzy jest już wystarczająco trudne. Więc przepraszam za to, co zamierzam zrobić w tym poście. Powiem Ci, że nie chodzi tylko o pomysły w Twojej bazie wiedzy, ale także o to, jak je przedstawiasz.

Zobacz, poza tymi pomysłami musisz upewnić się, że zawsze:

• Używając właściwego tonu
• Konsekwentne formatowanie wszystkiego tak samo

Co, z powodów, które wyjaśnię w następnej sekcji, jest w rzeczywistości zaskakująco trudne. W tym miejscu w grę wchodzi przewodnik po stylu bazy wiedzy.

Dlaczego Twoja baza wiedzy może być bałaganem w różnych stylach

Nie martw się zbytnio, jeśli Twoja baza wiedzy jest mieszanką różnych stylów. Zdarza się to wielu firmom, zwykle z jednego z dwóch powodów (a czasem obu!).

Po pierwsze, jeśli jesteś częścią zespołu, różne osoby mogą pisać dokumenty pomocnicze. Więc jeśli:

• Jim pisze artykuł A
• Sally pisze artykuł B

Te artykuły będą prawdopodobnie miały szalenie różne style i formatowanie… chyba że masz wstępnie zdefiniowany przewodnik po stylu.

Teraz, jeśli nie jesteś częścią zespołu, prawdopodobnie mówisz: „Jestem samotnym wilkiem – piszę wszystko sam. Więc nie muszę niczego odkładać na papier – to wszystko ja!”

I tak może być… jeśli napisałeś wszystkie artykuły z bazy wiedzy za jednym razem.

Ale oboje wiemy, że zwykle tak nie działa, prawda? Prawdopodobnie przy pierwszym wydaniu produktu napisałeś mnóstwo artykułów z bazy wiedzy.

Ale potem, trzy miesiące później, wypuszczasz nową funkcję. Teraz musisz napisać wpis do bazy wiedzy dla tej nowej funkcji i… ludzkie wspomnienia nie są tak dobre . Istnieje duża szansa, że ​​zrobisz coś inaczej, nawet jeśli nie próbujesz.

Niezależnie od tego, czy pracujesz solo, czy jako członek zespołu, opłaca się przelać na papier swój przewodnik dotyczący stylu bazy wiedzy.

Czy firmy faktycznie to robią? Czy przewodnik po stylu bazy wiedzy to prawdziwa rzecz?

Ok, za chwilę powiem Ci, jak stworzyć swój przewodnik po stylu. Ale najpierw chciałbym przedstawić kilka przykładów firm, które faktycznie to robią. Osiąga to dwa cele:

• To pokazuje, że nie tylko zmyślam, żeby tworzyć więcej treści na blogu
• Jest to przykład z życia wzięty, z którego możesz skorzystać, aby stworzyć własny przewodnik po stylu.

Przyjrzyjmy się najpierw Mozilli. Mozilla ma cały wpis w przewodniku po stylu swojej bazy wiedzy. Ponieważ Mozilla jest oprogramowaniem typu open source, szczególnie ważne jest dla nich, aby mieli przewodnik po stylu, aby własnymi słowami „uczynić bazę wiedzy obsługi Firefoksa spójną, co zaowocuje bazą wiedzy, która jest łatwa do czytania i współtworzenia”. Czytelny? To brzmi jak dobry cel dla twojej bazy wiedzy, prawda?

Przewodnik zawiera szczegółowe informacje, od wielkich liter, przez białe znaki, po przecinki seryjne.

Następnie warto przeczytać Voice & Tone MailChimp. Chociaż nie jest w 100% skoncentrowany na bazach wiedzy, zawiera wiele wpisów zarówno dla bazy wiedzy, jak i treści samouczka:

Podczas gdy przewodnik po stylach Mozilli jest bardziej skoncentrowany na stylu i formatowaniu, MailChimp decyduje się skupić bardziej na, cóż, głosie i tonie, niż na drobiazgowym formatowaniu.

Jak stworzyć przewodnik po stylu dla swojej bazy wiedzy

Rzuciłem ci kilka przykładów, ale muszę jeszcze przedstawić proces tworzenia własnego przewodnika po stylu bazy wiedzy. Więc naprawmy to!

Użyj konsekwentnej osoby

Czy kiedykolwiek czytałeś artykuł, w którym autor przełączał się między „ja” i „my”? Mam i możemy powiedzieć, że jest to niezmiernie zagmatwane.

Tak więc, jeśli zamierzasz użyć pierwszej osoby – wybierz jedną i bądź konsekwentny. Nawet jeśli grasz solo, nadal możesz wybrać opcję „my”. Zależy od Ciebie! Po prostu użyj tego samego.

Dodatkowo nie musisz nawet korzystać z pierwszej osoby. Możesz całkowicie zrezygnować z „ja” i „my”.

Tak naprawdę nie ma tu właściwej odpowiedzi – chodzi tylko o spójność.

Standaryzuj swoje formatowanie

Jeśli czytasz nasz ostateczny przewodnik po szablonach artykułów do bazy wiedzy, wiesz, że dobre bazy wiedzy zawierają wiele instrukcji wykonywanych małymi krokami. A te instrukcje w pewnym momencie będą zawierać takie języki jak:

Kliknij Plik .

A więc – czy to jest:

• Kliknij Plik
• Kliknij „Plik”
• Kliknij Plik

A kiedy faktycznie piszesz swoje listy, czy to:

• Krok 1: Kliknij to
• Krok 2: Kliknij to

Czy to jest tak:

• Kliknij to
• Kliknij to

Ponownie – możesz wybrać ten, który najbardziej Ci się podoba – ale niezależnie od tego, który wybierzesz, używaj go konsekwentnie w całej swojej bazie wiedzy.

Istnieją również inne opcje formatowania, które musisz podjąć – przewodnik po stylu Mozilli daje dobry pomysł na wszystko, co należy omówić, ale oto kilka pomysłów na początek:

• Wielkie litery w nagłówkach – czy użyjesz wielkości liter w zdaniu czy wielkości liter w tytule?
• Liczby – 10 czy dziesięć?
• Skróty – nie robić czy nie?
• Akronimy – CDN czy sieć dostarczania treści?

Jeśli korzystasz z jednego z motywów WordPress lub wtyczek z naszej bazy wiedzy, nasze wbudowane skróty i opcje formatowania pomogą Ci zachować spójność formatowania

Uzyskaj właściwy głos

Wreszcie, musisz wyjść poza formatowanie i ujednolicić swój głos.

Czy jesteś przyjacielem swojego klienta? A może jesteś Spockiem ze Star Trek, beznamiętnie przekazującym zimną, twardą mądrość?

W granicach rozsądku albo jest w porządku. O ile jest to spójne.

Ogólnie rzecz biorąc, należy postępować zgodnie ze wskazówkami dotyczącymi bazy wiedzy MailChimp. Sugeruję je nie tylko dlatego, że MailChimp faktycznie opublikował swój przewodnik, ale także dlatego, że myślę, że MailChimp ma jedną z najlepszych baz wiedzy.

Ich rada jest taka:

• Zawsze stawiaj na pierwszym miejscu, aby odpowiadać na pytania i informować czytelników. Żarty są czasami w porządku, ale nie wtedy, gdy odwracają uwagę od tego zasadniczego celu.
• Unikaj mówienia jak marketer – po prostu próbujesz pomóc.

Gdzie przechowywać swój przewodnik po stylach?

Nie powinieneś po prostu podejmować tych decyzji. Musisz też właściwie, wiesz, zapisać je w bezpiecznym miejscu.

Osobiście większość poradników stylistycznych, z którymi pracuję, to dokumenty Google Docs. W ten sposób możesz łatwo udostępnić swój przewodnik stylu i uzyskać do niego dostęp z różnych komputerów.

Ale jeśli wolisz inną metodę, wybierz to, co znasz. Jedyną naprawdę ważną rzeczą jest to:

Masz kopię przewodnika po stylu bazy wiedzy przechowywaną w bezpiecznym miejscu, w którym Ty lub inne osoby macie do niego dostęp, gdy potrzebujesz odświeżenia na temat formatowania bazy wiedzy.

Więc zapisz to na papierze i zacznij tworzyć bardziej spójne artykuły z bazy wiedzy!