Meta
Rodzaje artykułów (formaty i standard redakcyjny)
Compendium ma być użyteczne: rozdział ma się dać zamienić na politykę, szablon albo procedurę. Dlatego rozróżniamy formaty artykułów. Artykuły badawcze mają osobny, „czytelniczy” układ (spis treści, panel boczny, diagramy), natomiast przewodniki i standardy pozostają lżejsze — bliższe praktyce niż publikacji.
Rozszerzenie praktyczne
Operacyjny skrót
Ten rozdział należy do rodziny i ma formę Meta. Poniższe dopowiedzenie ma jeden cel: przełożyć treść na działania, które da się wdrożyć, zmierzyć i utrzymać.
Checklista
- Określ cel i zakres (co jest „w środku”, co „poza”).
- Zapisz zasady jako artefakt (polityka / szablon / checklista).
- Dodaj punkt kontrolny jakości (walidacja, review, test).
- Wersjonuj i mierz wpływ zmian.
- Zaplanuj wyjątki i ścieżkę eskalacji.
- Utrzymuj: przeglądy okresowe i rejestr decyzji.
Najczęstsze pułapki
- Brak jednoznacznych kryteriów jakości.
- Brak ownera i wersjonowania.
- Zasady bez egzekucji narzędziowej.
- Zmiany bez pomiaru i rollbacku.
Artefakty w Luage
policy
template
tests
trace
Standard działa dopiero wtedy, gdy ma właściciela, wersję, ślad (trace) oraz test regresyjny.
Szablon do skopiowania
Minimalny artefakt (szkic)
owner: "TBD"
version: 0.1
notes: "Wersjonuj i testuj"
To szkielet – dopasuj do zespołu i procesu.
Minimalne metadane
- Rodzaj (Standard / Procedura / Rejestr / Szablon...)
- Status (Draft / Recommended / Mandatory)
- Owner (jedna osoba/funkcja)
- Wersja + data aktualizacji
- Powiązania (polityki, szablony, testy, raporty)
Formaty
| Rodzaj | Po co | Minimalna struktura | Kiedy używać |
|---|---|---|---|
| Artykuł badawczy | Porządną teza + uzasadnienie: materiał „czytelniczy”, który broni się merytorycznie. | Streszczenie → tezy → założenia → rdzeń → wnioski → (opcjonalnie) źródła/diagramy. | Gdy temat wymaga precyzji i dłuższej argumentacji (np. inżynieria promptów/kontekstu). |
| Przewodnik | Przeprowadzić przez temat i doprowadzić do decyzji lub wdrożenia. | Cel → zakres → „w skrócie” → kroki/praktyki → checklisty → pułapki → linki powiązane. | Gdy odbiorca ma „zrobić”, a nie „przeczytać dla wiedzy”. |
| Standard | Normy „must/should”, które można egzekwować. | Zakres → reguły → przykłady → wyjątki → owner + wersja. | Gdy potrzebna jest spójność i rozliczalność. |
| Procedura | Powtarzalny przebieg pracy. | Wejścia → kroki → wyjścia → role → checklist. | Wdrożenia, audyty, incident response, release. |
| Szablon | Gotowiec do użycia (prompt, brief, RFC). | Wzór + zmienne + przykłady + „kiedy nie”. | Gdy zespół robi to samo wiele razy. |
| Checklist | Szybka kontrola jakości. | Lista pytań/warunków + kryteria „pass/fail”. | Review, QA, dopuszczenie do publikacji. |
| Wzorzec | Rozwiązanie typowego problemu z trade‑offami. | Problem → rozwiązanie → warianty → ryzyka. | Gdy „to zależy”, ale są dobre praktyki. |
| ADR | Utrwalenie decyzji i jej konsekwencji. | Kontekst → decyzja → alternatywy → konsekwencje. | Gdy decyzje mają koszt i wracają w dyskusjach. |
| Model | Stała rama organizacyjna (np. RACI). | Definicje ról → macierz → zasady użycia. | Gdy problemem jest „nikt nie odpowiada”. |
| Słownik | Terminologia: preferowane formy, zakazy, definicje. | Hasła → definicje → przykłady → mapowanie na polityki. | Gdy rozjeżdżają się pojęcia w produktach i komunikacji. |
| Meta | Porządek w Compendium i procesie. | Zasady redakcyjne, ownership, wersjonowanie. | Gdy biblioteka rośnie i trzeba ją utrzymać. |
Układ treści:
Artykuły badawcze korzystają z „szablonu naukowego” (spis treści, metadane, panel boczny, możliwość wstawiania równań i diagramów).
Pozostałe formaty (przewodniki/standardy/procedury) mogą być bardziej operacyjne i krótsze — ważniejsze jest, aby kończyły się artefaktem:
checklistą, szablonem, decyzją, rejestrem wyjątków albo planem wdrożenia.
W praktyce wystarczą 2–3 formaty na start (Standard + Procedura + Szablon). Reszta może dojść z czasem.
Governance
Statusy merytoryczne i kryteria awansu
Status merytoryczny mówi, na ile rozdział może być traktowany jako standard pracy. To nie jest „ocena stylu”, tylko gotowość do użycia i egzekwowania.
| Status | Przeznaczenie | Kryteria minimalne | Artefakt końcowy | Kadencja przeglądu |
|---|---|---|---|---|
| Robocze (Draft) | Do dopracowania; może inspirować, ale nie jest jeszcze „normą”. | Owner jest wskazany lub tymczasowy. Treść ma tezę, zakres i przykłady. Brak pełnej regresji jakości. | Notatka robocza / szkic checklisty / wstępny szablon. | Co 4–8 tygodni |
| Rekomendowane | Materiał produkcyjny. Można stosować w projektach i szkoleniach. | Jest owner, wersja, data aktualizacji i przeglądu. Ma przykłady + antywzorce. Jest przegląd domenowy (AI/SEC/Legal) wg potrzeb. | Checklista / szablon / procedura / minimalny zestaw testów. | Co 6 miesięcy |
| Obowiązkowe | Standard organizacyjny. Wymagane w procesie wdrożenia i review. | Ma ownera i governance. Zdefiniowane wyjątki (rejestr). Jest regresja (golden set) lub walidacja automatyczna. Jest ślad audytu zmian. | Policy‑as‑code / bramka jakości / testy regresji + procedura wyjątków. | Co 3 miesiące |
Praktyczna zasada awansu
Draft → Recommended, gdy rozdział zostawia artefakt do użycia i ma właściciela. Recommended → Mandatory, gdy jest egzekwowalny (polityka / walidacja / testy) oraz ma proces wyjątków i audyt zmian.
Taksonomia
Rodziny przewodników (5–7 obszarów pracy)
Rodziny porządkują przewodniki w Compendium. Nie narzucają jednego szablonu — narzucają oczekiwania: cel, artefakty i kryteria jakości.
Fundamenty i modele
Pojęcia, ograniczenia i modele mentalne. Materiały „ustawiające wspólny język”.
- Artefakty: definicje, diagramy, słownik pojęć.
- Sygnał sukcesu: mniej sporów terminologicznych, lepsze wymagania i briefy.
Projektowanie interakcji
Prompty, kontekst, format wyniku i wzorce prowadzenia modelu do decyzji.
- Artefakty: matryce, antywzorce, przykłady, „policy sandwich”, schematy wyjścia.
- Sygnał sukcesu: stabilny wynik mimo zmian danych i scenariuszy.
Wiedza i źródła
RAG, dokumenty, cytowalność, wersjonowanie wiedzy i uprawnienia do źródeł.
- Artefakty: zasady chunkingu, kontrakt cytowań, polityki dostępu, „freshness”.
- Sygnał sukcesu: odpowiedzi oparte o źródła, łatwy audyt „skąd to jest”.
Standard językowy
Ton, styl, terminologia i zasady redakcyjne organizacji – gotowe do egzekwowania.
- Artefakty: Tone of Voice, glosariusz, zakazane obietnice, ramy odpowiedzi.
- Sygnał sukcesu: spójny język w kanałach, mniej poprawek i eskalacji.
Jakość i ewaluacja
Testy, metryki, regresje i bramki jakości — tak, aby jakość była mierzona, a nie odczuwana.
- Artefakty: golden set, checklisty review, walidacje schematu, raporty jakości.
- Sygnał sukcesu: spadek naruszeń polityk i mniej „cichej degradacji”.
Bezpieczeństwo i ryzyko
Prywatność, prompt injection, halucynacje, DLP i kontrola ekspozycji danych.
- Artefakty: polityki PII, kontrakt danych, zasady odmów, playbook incydentu.
- Sygnał sukcesu: mniej incydentów, przewidywalne zachowania w sytuacjach granicznych.
Wdrożenie i governance
SSO/RBAC, integracje, rollout, ownership, wersjonowanie polityk i wyjątki.
- Artefakty: RACI, proces zmian, rejestr wyjątków, ślad audytu, procedury wdrożenia.
- Sygnał sukcesu: standard jest utrzymywany w czasie i nie degraduje procesu.
Zasada redakcyjna
Przewodnik powinien kończyć się artefaktem do użycia (checklista, matryca, wzorzec, fragment „policy‑as‑code”, test case).
Rodzina podpowiada, jaki artefakt jest najbardziej właściwy dla danego tematu.
Konwencje
- Jeden rozdział = jeden cel. Jak jest „wszystko o wszystkim”, nie da się tego wdrożyć.
- Reguły mają przykłady. Minimum: przykład zgodny i przykład błędny.
- Nie ma rozdziału bez ownera. Brak ownera to zapowiedź chaosu.
- Wersjonowanie jawne. Żeby wiedzieć, co obowiązywało kiedy.