Jak poprawnie dodać artykuł do bazy wiedzy

🧩 1. Struktura artykułu

Każdy artykuł w bazie wiedzy powinien mieć jasną strukturę, dzięki której czytelnik szybko znajdzie potrzebne informacje.

Zalecany układ:

1. Tytuł – krótki i konkretny, odpowiadający na pytanie lub opisujący problem

   Przykład: Jak dodać nowego użytkownika w systemie?

2. Krótki opis celu – jedno lub dwa zdania wyjaśniające, czego dotyczy artykuł.

3. Kroki lub instrukcja – przedstawiona w formie listy numerowanej lub punktowej.

4. Zrzuty ekranu / wideo – ułatwiają zrozumienie treści.

5. Najczęstsze błędy / uwagi – opcjonalna sekcja z poradami.

6. Powiązane artykuły – linki do innych tematów z bazy wiedzy.

✍️ 2. Styl i ton pisania

✅ Zalecenia:

• Pisz zwięźle i konkretnie – unikaj zbędnych opisów.

• Używaj języka drugiej osoby („Kliknij”, „Wybierz”), nie biernego („Powinno się kliknąć”).

• Stosuj spójne nazewnictwo – tak jak w systemie (np. „Panel ustawień”, „Karta klienta”).

• Jeśli instrukcja dotyczy konkretnego produktu lub wersji – zaznacz to na początku.

❌ Unikaj:

• Skrótów, które nie są wyjaśnione.

• Wewnętrznych nazw technicznych (chyba że są powszechnie znane w zespole).

• Mieszania języka polskiego i angielskiego (chyba że to nazwy własne w UI).

🖼️ 3. Zrzuty ekranu i grafiki

• Używaj czytelnych zrzutów ekranu w formacie .png lub .jpg.

• Zaznacz na nich najważniejsze elementy (np. strzałkami lub ramkami).

• Nie pokazuj danych wrażliwych (np. danych klientów).

• Umieszczaj obrazy bezpośrednio pod krokiem, którego dotyczą.

🧱 4. Formatowanie w edytorze HubSpot

W edytorze HubSpot możesz używać:

• Nagłówków (H2, H3) – do logicznego podziału treści,

• List numerowanych – dla instrukcji krok po kroku,

• Tabel – do porównywania ustawień lub opcji,

• Cytatów – do wyróżnienia uwag lub notatek.

Przykład:

💡 Wskazówka: jeśli chcesz dodać film instruktażowy, wklej link z YouTube – HubSpot automatycznie osadzi player.

🔁 5. Weryfikacja i publikacja

Przed publikacją sprawdź:

1. Czy artykuł odpowiada na konkretne pytanie lub problem?

2. Czy język jest zrozumiały dla użytkownika spoza firmy?

3. Czy wszystkie linki i grafiki działają poprawnie?

4. Czy artykuł ma przypisaną właściwą kategorię tematyczną?

5. Czy tytuł jest zoptymalizowany pod wyszukiwarkę (SEO)?

📚 6. Przykładowy szablon artykułu

Tytuł: Jak zresetować hasło do portalu klienta?
Cel: Dowiesz się, jak w kilku krokach przywrócić dostęp do portalu.
Kroki:

1. Wejdź na stronę logowania.

2. Kliknij „Nie pamiętasz hasła?”.

3. Wpisz adres e-mail i kliknij „Wyślij link resetujący”.

4. Odbierz wiadomość i ustaw nowe hasło.
   Wskazówka: Jeśli nie widzisz maila, sprawdź folder Spam.