Przejdź do treści
Biblioteka skilli
AI i agenci · Pisanie

okf

/okf

Podpowiada, jak pisać i utrzymywać strony w katalogu docs w formacie OKF v0.2, w tym dzielenie, linkowanie i importowanie notatek.

Repozytorium
beep-beginners ↗
Licencja
Apache-2.0
Ostatnia zmiana repozytorium
09.11.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
9
Skrypty
1
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 09.11.2026, bez odwołań do wycofanych modeli i API.

Licencja

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

Co sprawdzić przed instalacją
  • 1 skrypt w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.

Skrypty: upstream/scripts/validate.sh

Co robi i kiedy

Podpowiada, jak pisać i utrzymywać strony w katalogu docs w formacie OKF v0.2, w tym dzielenie, linkowanie i importowanie notatek.

Wyzwalacze z opisu

the docs
Oryginalny opis (EN)

How to write and maintain pages in docs/, which is an Open Knowledge Format (OKF v0.2) bundle (D60, D82). Use whenever you create, edit, enrich, split, cross-link or import pages under docs/, convert a Notion export, Obsidian vault or spreadsheet into docs/, fix a page that `kit docs validate` or `kit docs lint` flagged, or the user mentions OKF, the knowledge base, or "the docs". For saving what a session learned, use the `remember` skill.

Jak działa

  1. Read upstream for the format
  2. Kit overrides (these win over upstream)
  3. Maintenance loop
Sekcje z nagłówków SKILL.md, w oryginale · 69 linii, 570 słów
Podgląd SKILL.md
---
name: okf
description: >
  How to write and maintain pages in docs/, which is an Open Knowledge Format
  (OKF v0.2) bundle (D60, D82). Use whenever you create, edit, enrich, split,
  cross-link or import pages under docs/, convert a Notion export, Obsidian
  vault or spreadsheet into docs/, fix a page that `kit docs validate` or
  `kit docs lint` flagged, or the user mentions OKF, the knowledge base, or
  "the docs". For saving what a session learned, use the `remember` skill.
---

# OKF in this workspace

`docs/` is an Open Knowledge Format bundle: one concept per markdown file,
YAML frontmatter with a `type`, and `index.md` and `log.md` reserved in every
folder. The format guidance is the upstream OKF skill, vendored unchanged at a
pinned commit in `upstream/` (Apache-2.0, see `upstream/LICENSE` and
`UPSTREAM.json`). This file says where the kit overrides it.

## Read upstream for the format

- `upstream/UPSTREAM-SKILL.md`: frontmatter fields, `sources` with per-claim
  footnotes, cross-links, enrichment, and the conversion recipes.
- `upstream/references/spec-v02.md`: the spec the kit targets. Where it and
  `spec-v01.md` disagree, v0.2 wins. Never write v0.1 forms: no `timestamp`
  key, no `# Citations` heading, no bare-date `generated.at`.
- `upstream/references/conversion.md` and `examples.md`: importing Notion,
  Obsidian or CSV material.

## Kit overrides (these win over upstream)

1. **New pages go through the kit.** `kit docs new` sets `generated`,
   `status: draft`, `stale_after` from the type's default (D61) and updates
   the log and indexes. Write the body yourself; don't hand-roll frontmatter
   for a new page.
2. **Never write `index.md` or `log.md` by hand**, and never run
   `okflint index --apply`. `kit index` writes the indexes with trust tiers;
   `kit land` and `kit docs new` append to the log.
3. **Validate with the kit, not with `validate.sh`.** The user is on Windows,
   and `validate.sh` is bash. `kit docs validate` is the fast check and needs
   nothing installed. `kit docs lint` runs okflint at a version the kit pins,
   through `uv`, with the kit's manifest. It parses YAML strictly and checks
   links and the v0.2 field shapes. Never ask the user to install okflint
   or anything else for this: if `uv` or the network is missing, lint reports
   `skipped` and that's fine.
4. **Quote any value that contains `: ` or ` #`.** The kit's own reader
   forgives `title: Fees: 10%`, but standard YAML readers reject it
   (`E7` in `kit docs validate`, `F001` in `kit docs lint`).
5. **Trust fields belong to the kit.** Record a check with
   `kit docs verify <id> --by human:<name>` (the user confirmed it) or
   `--by claude-code/<model>` (you rechecked it against its `sources`), and
   retire a page with `kit docs deprecate <id> --reason "..."`. Don't edit
   `verified`, `status` or `stale_after` by hand. `status` is the page's
   state (draft, stable, deprecated); the trust tier (unverified,
   machine-confirmed, human-reviewed) comes from `verified`. Neither is a
   project's lifecycle, which lives in `.packet.json`.
6. **No Knowledge Catalog.** Ignore the `kcmd` and Google Cloud sections;
   this workspace syncs through git and GitHub only.
7. **The never-list applies to every page**, imports included: no health,
   relationships, personal finances, other people by name, or secrets. Drop
   such material from an import and tell the user in one line that you did.
8. **One concept per file.** When lint reports `S202` (split candidate),
   split the page only if it really holds two facts; otherwise leave it.

## Maintenance loop

```
uv run --script "${CLAUDE_PLUGIN_ROOT}/scripts/kit.py" docs validate      # structure, offline, instant
uv run --script "${CLAUDE_PLUGIN_ROOT}/scripts/kit.py" docs lint          # okflint: strict YAML, links, v0.2 shapes
uv run --script "${CLAUDE_PLUGIN_ROOT}/scripts/kit.py" docs stale         # pages past stale_after: recheck or deprecate
uv run --script "${CLAUDE_PLUGIN_ROOT}/scripts/kit.py" docs duplicates    # drafts that say the same thing
uv run --script "${CLAUDE_PLUGIN_ROOT}/scripts/kit.py" index              # rewrite every folder's index.md
```

Fix every error and save with `kit land --message "Docs: <one line>"`.
Warnings are yours to judge and never reach the user. The weekly
`okf-validate` chore runs `validate` and `lint` and tells the user one line
only when a page needs fixing.
Pliki w paczce (9)
  • SKILL.md 4 KB
  • UPSTREAM.json 2 KB
  • upstream/LICENSE 10 KB
  • upstream/UPSTREAM-SKILL.md 22 KB
  • upstream/references/conversion.md 4 KB
  • upstream/references/examples.md 15 KB
  • upstream/references/spec-v01.md 15 KB
  • upstream/references/spec-v02.md 37 KB
  • upstream/scripts/validate.sh 8 KB

Wersje

RepozytoriumWynikLicencja
Ta strona · kriegcloud/beep-beginners100Apache-2.0
akillness/jeo-skills100MIT
cofin/flow100Apache-2.0
scaccogatto/okf-skills100MIT
saschb2b/skills100MIT
cofin/flow100Apache-2.0
gannonh/kata100MIT
mattjoyce/okf-skill100Apache-2.0
sergio-sisternes-epam/atlas90Apache-2.0

Migawka bazy z 13.11.2026 · wersja paczki a2fe3890a8ad (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100okf-wiki
    Buduje bazę wiedzy w Open Knowledge Format (OKF) z istniejących dokumentów, notatek lub repozytorium i tworzy szkielet wiki OKF.
  • 95okf-open-knowledge-format
    Tworzy, waliduje i wzbogaca paczki Open Knowledge Format (OKF), czyli wiedzy organizacji w plikach markdown z frontmatterem YAML, czytelnej dla agentów.
  • 100okf-maintain-knowledge
    Tworzy i aktualizuje paczki wiedzy OKF o usługach, API, schematach i decyzjach, gdy zmienia się kod lub dokumentacja projektu.
  • 100okf-init
    Tworzy standardową strukturę knowledge w repozytorium zgodnie z profilem OKF v0.2 i przygotowuje ją do odczytu w Obsidian.
  • 95okf-authoring
    Tworzy paczki wiedzy w formacie Open Knowledge Format z plików markdown z nagłówkami YAML na podstawie źródeł danych.
  • 100okf-ops
    Ocenia, waliduje i wdraża Open Knowledge Format (OKF) w bazach wiedzy z markdown i frontmatter, sprawdzając zgodność frontmatter i gotowość repozytorium.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.