@forwardimpact/map 0.15.3 → 0.15.4
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 +1 -1
- package/README.md +0 -67
package/package.json
CHANGED
package/README.md
DELETED
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
# @forwardimpact/map
|
|
2
|
-
|
|
3
|
-
A public site describing the data model for consumption by AI agents and
|
|
4
|
-
engineers.
|
|
5
|
-
|
|
6
|
-
## Role in the Vision
|
|
7
|
-
|
|
8
|
-
The Map product is the fundamental underpinning of all Forward Impact products.
|
|
9
|
-
It defines how engineering competencies, career progression, and agent
|
|
10
|
-
capabilities are structured\u2014and publishes that structure in
|
|
11
|
-
machine-readable formats so AI agents can reliably interpret and work with
|
|
12
|
-
career framework data.
|
|
13
|
-
|
|
14
|
-
Making the data model well understood is a first-class goal. By publishing JSON
|
|
15
|
-
Schema and RDF/SHACL definitions alongside canonical example data, we ensure
|
|
16
|
-
that every consumer—human or AI—shares a consistent understanding of the data
|
|
17
|
-
model.
|
|
18
|
-
|
|
19
|
-
## What It Does
|
|
20
|
-
|
|
21
|
-
- **Public data model** — JSON Schema and RDF/SHACL definitions for skills,
|
|
22
|
-
behaviours, disciplines, tracks, and levels
|
|
23
|
-
- **Data loading** — Parse and validate YAML data files
|
|
24
|
-
- **Validation** — Enforce referential integrity, required fields, and schema
|
|
25
|
-
compliance
|
|
26
|
-
- **Index generation** — Generate browser-compatible file indexes
|
|
27
|
-
- **Example data** — Canonical examples for testing and reference
|
|
28
|
-
|
|
29
|
-
## Usage
|
|
30
|
-
|
|
31
|
-
```sh
|
|
32
|
-
# Validate all data files
|
|
33
|
-
npx fit-map validate
|
|
34
|
-
|
|
35
|
-
# Generate index files for browser
|
|
36
|
-
npx fit-map generate-index
|
|
37
|
-
|
|
38
|
-
# Validate SHACL ontology
|
|
39
|
-
npx fit-map validate --shacl
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
## Package Exports
|
|
43
|
-
|
|
44
|
-
```javascript
|
|
45
|
-
import { loadAllData, loadCapabilities } from "@forwardimpact/map";
|
|
46
|
-
import { validateAll } from "@forwardimpact/map/validation";
|
|
47
|
-
import {
|
|
48
|
-
SKILL_PROFICIENCIES,
|
|
49
|
-
BEHAVIOUR_MATURITIES,
|
|
50
|
-
} from "@forwardimpact/map/levels";
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
## Data Structure
|
|
54
|
-
|
|
55
|
-
```
|
|
56
|
-
examples/
|
|
57
|
-
├── levels.yaml # Career levels
|
|
58
|
-
├── stages.yaml # Lifecycle stages
|
|
59
|
-
├── drivers.yaml # Organizational outcomes
|
|
60
|
-
├── disciplines/ # Engineering specialties
|
|
61
|
-
├── tracks/ # Work contexts (platform, SRE, etc.)
|
|
62
|
-
├── behaviours/ # Approach to work
|
|
63
|
-
├── capabilities/ # Skills grouped by area
|
|
64
|
-
└── questions/ # Interview questions
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
See the [documentation](../../website/docs/map/index.md) for details.
|