superbee 0.1.2-pre.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "superbee",
3
- "version": "0.1.2-pre.1",
3
+ "version": "0.1.2",
4
4
  "type": "module",
5
5
  "description": "Agent-facing Superbee CLI for reading and writing local OKF knowledge bundles: context notes, docs, cross-links, and live bundle Views.",
6
6
  "keywords": [
@@ -0,0 +1,62 @@
1
+ # Modeling and delivery
2
+
3
+ Read this only after the user accepts a durable domain-modeling change.
4
+
5
+ ## Inspect before choosing a representation
6
+
7
+ Use the current CLI as the syntax authority:
8
+
9
+ ```sh
10
+ superbee bundle locate
11
+ superbee list --limit 50
12
+ superbee kinds
13
+ superbee recipes
14
+ superbee link list --limit 100
15
+ ```
16
+
17
+ Run the relevant command's `--help` before writing. Preserve source documents and existing domain
18
+ definitions.
19
+
20
+ ## Choose the least structure that removes the recurring cost
21
+
22
+ - **Generic document:** one important record or a representative example while the shape is still
23
+ uncertain. OKF documents do not need a governing Kind.
24
+ - **Kind:** repeated instances need shared vocabulary, fields, lifecycle, sections, freshness, or
25
+ relationship rules. Create a Kind only when the repeated shape is already supported by evidence.
26
+ - **Recipe:** multiple stable definitions should be reusable in other bundles. Recipes contain
27
+ definitions and guidance, never the user's instance data.
28
+ - **View:** humans repeatedly need the same comparison, timeline, graph, board, dashboard, or
29
+ interactive decision surface. The underlying documents and relationships remain authoritative.
30
+ - **Task/Roadmap:** accountable, sequenced coordination benefits from execution state and a governing
31
+ overview. Do not use them merely because their recipes are available.
32
+
33
+ For a newly recognized domain, create one clearly labeled representative generic document first.
34
+ Do not introduce a new Kind until the user has used that record or at least two existing records
35
+ already demonstrate the same stable fields or relationships. When the current bundle already
36
+ contains several examples that establish a stable repeated shape, creating the Kind and one valid
37
+ instance together is appropriate.
38
+
39
+ ## Delivery loop
40
+
41
+ 1. State the recurring problem and the future outcome in the user's terms.
42
+ 2. Inspect existing vocabulary and avoid a competing source of truth.
43
+ 3. Keep unknown facts explicitly unknown; do not infer operational state from silence.
44
+ 4. Create the smallest model and one representative instance. Use a temporary recipe directory
45
+ plus `superbee recipe add <path>` when installing new Kind definitions, so normal validation and
46
+ expect-absent behavior apply.
47
+ 5. Relate the new record to its actual evidence, policies, decisions, or dependencies.
48
+ 6. Run `superbee status`, read the new record, and inspect its links. Repair only defects caused by
49
+ this change.
50
+ 7. Remove temporary authoring or staging directories, present the authoritative result, and give a
51
+ brief value receipt.
52
+
53
+ Use `--body-file` for multiline Markdown. Use `superbee new "<Kind>" --help` for the exact fields
54
+ of an installed Kind. Prefer semantic no-ops, actor attribution, and version-aware updates when the
55
+ CLI exposes them.
56
+
57
+ ## Evolve from use
58
+
59
+ Refine fields or relationships only after actual instances expose a recurring need. Package a
60
+ recipe only after the definitions stabilize. Add a View only when repeated human interpretation
61
+ cost is visible. Periodically consolidate or retire structure that no longer earns its cognitive
62
+ cost.