executing-plans
executing-plans
Use when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available
kb-initScaffold a new OKF knowledge bundle in this project — run when starting a wiki or adding a bundle under knowledge/.
Independent GitHub snapshot · Automated classification · Original documentation governs
Scaffold a conformant bundle per kb. Your unique work is the schema layer (step 2) and adapting the seed (step 3).
Read the version profile before writing. New bundles target OKF v0.2. Read the glossary if the terms below are unfamiliar.
Default to a bundle at knowledge/. Accept overrides from the user's request:
docs/kb) → scaffold there instead.ci bundle") → scaffold at knowledge/<name>/ and treat knowledge/
as a multi-bundle folder: ensure a top-level knowledge/index.md exists that catalogs the
bundles (create it if missing; add this bundle to it).If the target directory already contains a bundle (a root index.md), stop and report it — do not
overwrite. Offer kb-document for repository documentation or
kb-ingest for captured sources.
Choose an honest producer actor for generated.by: the current agent/tool as
<producer>/<version>, never human:<id> unless the human actually authored the content.
Completion criterion: the target path, bundle name, and producer actor are fixed, and the target is confirmed not to collide with an existing bundle.
The scaffold is deterministic; the schema layer needs judgment, so gather it first. Inspect the workspace for signal (README, existing docs, the code, any notes the user points at), determine whether this is a repository-documentation or captured-source bundle, and ask the user only what you still can't infer:
type vocabulary (e.g. person, deal, metric; or character, chapter, theme).Keep it short — a few provisional types and a one-line routing rule is enough to start. This is
an initial vocabulary, not a closed enum; the schema layer co-evolves as ingest reveals the domain.
Reference (captured source material) and Spec Section (the bundle's own schema documents) are
workflow types supplied by the seed, not domain choices the user needs to design.
Interaction contract:
kb-init again.Completion criterion: you can name the bundle's initial type values and either its raw sources
plus a one-line ingest routing rule, or its repository scope plus a one-line documentation routing
rule.
Read ../kb/example-bundle/ as the source scaffold, then write its adapted artifacts into the target. Do not first write an unmodified copy and then overwrite it: create the directories and write each target file once with its final, domain-specific content. Work quietly after the user's approval; do not narrate each read or write.
If a prior attempt already created a target file, it is no longer new: read that file immediately before editing it, preserve valid work, and resume from the incomplete step. Never retry a read-before-write failure blindly or dismiss it as a false alarm.
| Artifact | Action |
|---|---|
index.md | Keep okf_version: "0.2" frontmatter; replace the body with this bundle's title and section list. |
log.md | Start fresh with a single dated **Creation** entry. |
spec/types.md | Keep Spec Section and Reference; replace the example domain types and set generated to the current producer/time. |
spec/conventions.md | Replace with folder taxonomy, routing, custody, and trust rules; set generated to the current producer/time. |
concepts/* | Remove example entities (customers, orders); leave concepts/ empty or create domain starter folders. |
references/* | Remove the synthetic example source; leave references/ empty until a real source is ingested. |
knowledge/index.md | If multi-bundle (step 1): create or update the catalog entry for this bundle. |
Use ../kb/templates/ for any new concept/index/log files.
Completion criterion: the bundle exists on disk as OKF v0.2; every row above is accounted for;
all created concepts use generated rather than legacy timestamp; spec/types.md and
spec/conventions.md describe this project; multi-bundle catalog updated if applicable.
Run kb-lint if available; otherwise verify the bundle is conformant per kb (SPEC §11 — the one hard rule).
Completion criterion: zero conformance errors.
Tell the user the bundle is ready and where it lives. For a codebase bundle, hand off to
kb-document; otherwise hand off to
kb-ingest. In both cases, kb-query answers from the
result. If this project uses CLAUDE.md/AGENTS.md, offer to add a one-line pointer so agents read
the bundle's root index.md before relevant tasks; never add it without agreement.