Jérôme Bousquié
55 lines
2.0 KiB
Markdown
55 lines
2.0 KiB
Markdown
---
|
||
type: Specification
|
||
title: Open Knowledge Framework (OKF) v0.2 Specification
|
||
sources: [SPEC.md]
|
||
generated: true
|
||
verified: false
|
||
status: draft
|
||
stale_after: 2026-12-31
|
||
---
|
||
|
||
# Open Knowledge Framework – v0.2 Summary
|
||
|
||
This document provides a concise overview of the OKF v0.2 specification as implemented in the WSG project. It aggregates the key concepts defined in the fragment files under `docs/rules/fragments/`.
|
||
|
||
## 1. Cross‑linking and Paths (Fragment 05)
|
||
- Local bundle links use the `@/` prefix.
|
||
- Paths are written without the `.md` extension.
|
||
- Enables a graph of inter‑concept relationships.
|
||
|
||
## 2. Provenance – `sources` (Fragment 06)
|
||
- `sources` records origin identifiers (files, URLs).
|
||
- Supports traceability and impact analysis.
|
||
|
||
## 3. Trust – `generated` / `verified` (Fragment 07)
|
||
- `generated: true` for automatically produced docs.
|
||
- `verified: true` only after human review.
|
||
|
||
## 4. Lifecycle – `status` & `stale_after` (Fragment 08)
|
||
- `status` values: `draft`, `current`, `deprecated`, `archived`.
|
||
- `stale_after` ISO‑8601 date triggers review.
|
||
|
||
## 5. Actor Convention (Fragment 09)
|
||
- `actor` field follows `<type>/<name>` (e.g., `person/jdoe`).
|
||
- Provides attribution and accountability.
|
||
|
||
## 6. Attested Computation (§10) (Fragment 10)
|
||
- `computation` describes a deterministic script and its arguments.
|
||
- Successful run allows promotion to `verified: true`.
|
||
|
||
## 7. Index Files (Fragment 11)
|
||
- `index.md` lists bundle concepts for humans and tools.
|
||
- Must stay synchronized with actual content.
|
||
|
||
## 8. Log Files (Fragment 12)
|
||
- `log.md` records timestamped, actor‑identified changes.
|
||
- Enables audit trails and diff generation.
|
||
|
||
## 9. Changes from v0.1 (Fragment 13)
|
||
- Introduced `stale_after`, `actor`, `computation` fields.
|
||
- Standardised boolean flags and cross‑link syntax.
|
||
|
||
---
|
||
|
||
*All fragment files are stored under `docs/rules/fragments/` and should be kept in sync with this summary. Future revisions of the specification will update the `status` and `stale_after` fields accordingly.*
|