Jak tworzyć efektywne źródła wiedzy dla systemów opartych na RAG (odkrywanie wiedzy)

Niniejszy uid zawiera praktyczne zalecenia dotyczące pisania lub ulepszania artykułów, podręczników i uid , które będą wykorzystywane jako materiał źródłowy w systemie sztucznej inteligencji RAG (Retrieval-Augmented Generation). Celem jest maksymalne ułatwienie modelowi zrozumienia i wyszukiwania istotnych, precyzyjnych informacji.

1. 🎯 Określ jasny cel każdego dokumentu

Każdy dokument powinien odpowiadać na jedno konkretne pytanie lub przypadek użycia .

W tytule i nagłówkach wyraźnie określ, czego dotyczy dokument (np. „Jak zresetować hasło w ESM” , „Konfiguracja sieci VPN dla pracowników zdalnych” ).

Unikaj mieszania tematów — lepiej podzielić długie dokumenty na mniejsze, bardziej szczegółowe.

2. 🧱 Używaj uporządkowanych sekcji i jasnych nagłówków

Podziel treść na logiczne sekcje: Wstęp, Krok po kroku, Notatki, Typowe problemy, FAQ .

Stosuj nagłówki H2/H3 — dzięki temu model łatwiej zrozumie strukturę i kontekst treści.

Każda czynność lub instrukcja powinna znajdować się w osobnym kroku lub akapicie.

3. 🔢 Używaj numerowanych kroków i punktów wypunktowanych

Zamiast długich akapitów stosuj:

## How to reset your password
1. Go to the login page.
2. Click on “Forgot password”.
3. Enter your company email address.
4. Check your inbox and click the reset link.

Sztuczna inteligencja radzi sobie z tym formatem znacznie lepiej niż z tekstem niestrukturyzowanym.

4. 📌 Używaj spójnej terminologii

Stosuj jasne i spójne nazwy systemów, zespołów, funkcji i akronimy (np. „Platforma ESM”, „Zespół wsparcia IT”, „FortiClient VPN”).

Unikaj stosowania skrótów lub żargonu wewnętrznego, chyba że są one zdefiniowane.

5. 🧠 Pro kontekst w dokumencie

Dodaj krótkie wyjaśnienie, dlaczego coś jest robione. Na przykład:

„Zgodnie z polityką bezpieczeństwa firmy, resetowanie hasła jest wymagane co 90 dni”.

Model lepiej rozumie cel i intencję, gdy dostępny jest kontekst.

6. 🔍 Podkreśl najważniejsze informacje

Podkreśl ważne punkty (takie jak ścieżki, ustawienia, ostrzeżenia, wskazówki) pogrubionym tekstem lub formatowaniem wizualnym :

Uwaga: po zresetowaniu hasła konieczne będzie ponowne zalogowanie się do sieci VPN.

Pomaga to modelowi rozpoznać, co jest ważne w odpowiedzi.

7. 📂 Jeden dokument = jeden temat

❌ Zła praktyka: „Wszystko, co musisz wiedzieć o ESM”

✅ Dobre praktyki:

„Jak złożyć wniosek urlopowy w systemie ESS2”

„Jak sprawdzić status zgłoszenia w ESM”

„Jak włączyć uwierzytelnianie wieloskładnikowe (MFA) dla konta firmowego”

8. 💬 Uwzględnij często zadawane pytania i typowe pytania użytkowników

Sztuczna inteligencja często odpowiada na pytania w języku naturalnym. Uwzględnij sekcję taką jak:

## Frequently Asked Questions
- What if I didn't receive the reset email?
- Can I reset my password outside the office network?

9. 🧪 Przetestuj przed publikacją

Zadaj prawdziwe pytania użytkownikom i sprawdź, czy odpowiedzi można łatwo znaleźć w tekście.

Opcjonalnie możesz przetestować dokument za pomocą systemu sztucznej inteligencji i ocenić jakość wygenerowanych odpowiedzi.

10. 🧼 Używaj prostego i poprawnego języka

Sztuczna inteligencja działa najlepiej przy zdaniach krótkich, jasnych i poprawnych gramatycznie .

Unikaj zbyt technicznych i skomplikowanych zwrotów.

Stosuj bezpośrednie instrukcje zamiast języka warunkowego lub sugestywnego.

✍️ Przykład: Zły kontra Dobry

❌ Źle:

Jeśli użytkownik ma problemy z logowaniem, może spróbować przypomnieć sobie hasło lub przejść na stronę logowania ESM i skorzystać z opcji resetowania hasła.

✅ Dobrze:

Jak zresetować hasło:

Przejdź do strony logowania ESM.

Kliknij „Zapomniałem hasła”.

Wprowadź firmowy adres e-mail.

Sprawdź swoją skrzynkę odbiorczą i kliknij link resetujący.

⚠️ Ważne: Używaj jednego języka we wszystkich dokumentach

Aby utrzymać wysoki poziom dokładności i jakości odpowiedzi w systemie sztucznej inteligencji, wszystkie dokumenty źródłowe muszą być napisane w tym samym języku . Mieszanie języków w bazie wiedzy znacząco obniża wydajność modelu i jasność odpowiedzi.

Prosimy o wcześniejsze podjęcie decyzji, który język główny będzie używany (np. angielski, fiński, niemiecki, szwedzki lub polski) i upewnienie się, że wszystkie artykuły, instrukcje i dokumentacja są spójne i zgodne z tym wyborem.