@thanbir-tamim/enterprise-project-intelligence-agent 0.1.1 → 0.2.0

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.
Files changed (38) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +302 -49
  3. package/assets/figures/feasibility-scoring-engine.png +0 -0
  4. package/assets/figures/hero-architecture.png +0 -0
  5. package/assets/figures/skills-interaction-map.png +0 -0
  6. package/docs/SUPPORTED_FORMATS.md +4 -4
  7. package/examples/synthetic-inventory-system/ai-opportunity-matrix/AI_OPPORTUNITY_MATRIX.md +4 -4
  8. package/examples/synthetic-inventory-system/generated-docs/INVENTORY_SUMMARY.md +17 -0
  9. package/examples/synthetic-inventory-system/generated-docs/evidence-index.json +78 -0
  10. package/examples/synthetic-inventory-system/generated-docs/inventory.json +26 -0
  11. package/examples/synthetic-inventory-system/presentation/DEMO_DECK.md +69 -55
  12. package/examples/synthetic-inventory-system/presentation/demo-deck.json +194 -16
  13. package/package.json +2 -1
  14. package/scripts/cli.mjs +20 -14
  15. package/scripts/lib/skills.mjs +1 -1
  16. package/scripts/release-audit.mjs +73 -70
  17. package/skills/corporate-presentation-generator/SKILL.md +49 -23
  18. package/skills/corporate-presentation-generator/scripts/outline-to-deck-json.mjs +77 -0
  19. package/skills/documentation-quality-auditor/SKILL.md +28 -21
  20. package/skills/documentation-quality-auditor/references/audit-checks.md +15 -8
  21. package/skills/documentation-quality-auditor/scripts/audit-docs.mjs +192 -32
  22. package/skills/engineering-knowledge-transfer/SKILL.md +1 -5
  23. package/skills/enterprise-ai-integration-planner/SKILL.md +13 -15
  24. package/skills/enterprise-ai-integration-planner/references/feasibility-scoring.md +26 -5
  25. package/skills/enterprise-ai-integration-planner/scripts/score-opportunity.mjs +32 -15
  26. package/skills/presentation-compliance-validator/SKILL.md +15 -15
  27. package/skills/presentation-compliance-validator/references/rule-schema.md +67 -10
  28. package/skills/presentation-compliance-validator/scripts/validate-deck.mjs +48 -11
  29. package/skills/project-documentation-discovery/SKILL.md +25 -8
  30. package/skills/project-documentation-discovery/references/format-matrix.md +4 -4
  31. package/skills/project-documentation-discovery/scripts/inventory.mjs +174 -100
  32. package/skills/project-documentation-discovery/scripts/secrets.mjs +99 -0
  33. package/skills/project-knowledge-assistant/SKILL.md +1 -7
  34. package/skills/software-change-impact-analyzer/SKILL.md +15 -11
  35. package/skills/software-reverse-engineering/SKILL.md +14 -10
  36. package/skills/software-reverse-engineering/references/system-map-schema.md +27 -0
  37. package/skills/technical-document-generator/SKILL.md +6 -8
  38. package/skills/technical-document-generator/scripts/render-markdown-to-html.mjs +76 -66
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.2.0
4
+
5
+ - Hardened and fixed all 20 evaluation findings (F-01..F-20): planner 0-score -> insufficient-evidence and documented blocker taxonomy; honest YAML/CSV extraction; entropy-based secret detection with file/line records; XSS-safe Markdown renderer with ordered lists/blockquotes; auditor anchor/citation/contradiction checks + CLI; executable deck-JSON handoff; schema-validated presentation rules; single-line skill descriptions for cross-harness portability.
6
+ - Added scripts: project-documentation-discovery/secrets.mjs, corporate-presentation-generator/outline-to-deck-json.mjs; software-reverse-engineering system-map schema.
7
+ - Contradiction detector precision fix (suppresses templated/series false positives).
8
+ - Added Performance evaluation section to the README (anonymized aggregates).
9
+ - 42/42 tests; release-audit 0 findings on the published package.
10
+
11
+ ## 0.1.2
12
+
13
+ - Rewrote README.md: added badges, an ASCII banner, a table of contents, and a detailed
14
+ per-skill section for all 10 skills (purpose, inputs, outputs, example links).
15
+ - No functional changes to skills or scripts.
16
+
3
17
  ## 0.1.1
4
18
 
5
19
  - Fixed stale README "Status" section (incorrectly said "unpublished" after the package was
package/README.md CHANGED
@@ -1,54 +1,219 @@
1
- # Enterprise Project Intelligence & AI Integration Agent
1
+ ```
2
+ ███████╗██████╗ ██╗
3
+ ██╔════╝██╔══██╗██║
4
+ █████╗ ██████╔╝██║
5
+ ██╔══╝ ██╔══██╗██║
6
+ ███████╗██║ ██║██║
7
+ ╚══════╝╚═╝ ╚═╝╚═╝
8
+ Enterprise Project Intelligence & AI Integration Agent
9
+ ──────────────────────────────────────────────────────
10
+ Evidence-grounded reverse engineering + AI opportunity planning,
11
+ as a reusable, project-agnostic Agent Skills toolkit.
12
+ ```
13
+
14
+ <p align="center">
15
+ <img src="assets/figures/hero-architecture.png" alt="Enterprise Project Intelligence Pipeline" width="100%">
16
+ </p>
17
+
18
+ <p align="center">
19
+ <a href="https://www.npmjs.com/package/@thanbir-tamim/enterprise-project-intelligence-agent"><img src="https://img.shields.io/npm/v/@thanbir-tamim/enterprise-project-intelligence-agent?color=cb3837&label=npm" alt="npm version"></a>
20
+ <a href="https://www.npmjs.com/package/@thanbir-tamim/enterprise-project-intelligence-agent"><img src="https://img.shields.io/npm/dm/@thanbir-tamim/enterprise-project-intelligence-agent?color=cb3837" alt="npm downloads"></a>
21
+ <a href="https://github.com/ThanbirTamim/enterprise-project-intelligence/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="License"></a>
22
+ <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D18-339933?logo=node.js&logoColor=white" alt="Node >= 18"></a>
23
+ <img src="https://img.shields.io/badge/dependencies-zero-brightgreen" alt="Zero required dependencies">
24
+ <img src="https://img.shields.io/badge/skills-10-blueviolet" alt="10 Agent Skills">
25
+ <img src="https://img.shields.io/badge/tests-23%2F23%20passing-success" alt="23/23 tests passing">
26
+ </p>
27
+
28
+ <p align="center"><strong>⭐ If this toolkit saves you a round of "where should we even put AI in this app?" meetings, consider starring the repo.</strong></p>
2
29
 
3
- A project-agnostic, organization-agnostic **Agent Skills toolkit** that helps an AI assistant:
30
+ ---
4
31
 
5
- 1. Ingest and inventory a software project's documentation and (optionally) source code.
6
- 2. Reconstruct architecture, workflows, APIs, and data model from the available evidence.
7
- 3. Answer questions about the project with source citations.
8
- 4. Discover, score, and plan **AI integration opportunities** — including for projects with *no*
9
- existing AI — always comparing against the simplest non-AI alternative, and never letting a high
10
- score override a critical security/privacy/legal blocker.
11
- 5. Generate evidence-backed technical documentation and corporate presentations against
12
- user-supplied (not hardcoded) style guidelines.
13
- 6. Audit documentation quality, trace change impact, and generate onboarding/knowledge-transfer
14
- material.
32
+ ## What is this?
15
33
 
16
- This repository ships **skills** (instructions for an AI coding agent), **reference scripts**
17
- (deterministic, dependency-free Node.js helpers), **templates**, and a **synthetic** worked example.
18
- It contains **no real organization's project data, branding, or proprietary guideline text**.
34
+ A **project-agnostic, organization-agnostic Agent Skills toolkit** — a set of instructions, reference
35
+ scripts, and templates that let an AI coding agent:
36
+
37
+ > **Ingest → Reconstruct → Ask → Plan AI → Document → Present → Audit → Maintain**
38
+
39
+ ...for *any* software project you point it at, grounding every material claim in cited evidence
40
+ instead of plausible-sounding guesses.
41
+
42
+ It ships **zero required third-party dependencies**, works with **any AI agent that supports the
43
+ Agent Skills convention** (a `SKILL.md` with YAML frontmatter per skill), and treats "should we even
44
+ use AI here?" as a real question with a real non-AI alternative — not a foregone conclusion.
45
+
46
+ ```
47
+ docs/code ──▶ project-documentation-discovery ──▶ evidence-index.json
48
+ │
49
+ ▼
50
+ software-reverse-engineering ──▶ architecture + data model
51
+ │
52
+ ┌─────────────────┼──────────────────────┐
53
+ ▼ ▼ ▼
54
+ project-knowledge- enterprise-ai- documentation-quality-
55
+ assistant integration-planner auditor
56
+ (cited Q&A) (opportunities, scores, (contradictions,
57
+ roadmap, security) stale docs, gaps)
58
+ │ │ │
59
+ └─────────────────┼───────────────────────┘
60
+ ▼
61
+ technical-document-generator · corporate-presentation-generator
62
+ (Markdown / HTML / decks, all cited)
63
+ ```
64
+
65
+ <p align="center">
66
+ <img src="assets/figures/skills-interaction-map.png" alt="Skills Composition and Interaction Map" width="95%">
67
+ </p>
68
+
69
+ ## Table of contents
70
+
71
+ - [Why this exists](#why-this-exists)
72
+ - [Quick start](#quick-start)
73
+ - [The 10 skills, in detail](#the-10-skills-in-detail)
74
+ - [Repository layout](#repository-layout)
75
+ - [Confidentiality by construction](#confidentiality-by-construction)
76
+ - [Testing & validation](#testing--validation)
77
+ - [Installation](#installation)
78
+ - [Documentation](#documentation)
79
+ - [Status](#status)
80
+ - [Contributing & license](#contributing--license)
19
81
 
20
82
  ## Why this exists
21
83
 
22
84
  Most "apply AI to my project" advice is generic. This toolkit instead:
23
85
 
24
- - Grounds every material claim in cited evidence from the user's own project corpus.
25
- - Treats "should we even use AI here?" as a real question with a real non-AI alternative, not a
26
- foregone conclusion.
27
- - Separates deterministic checks (file inventory, schema validation, compliance rule-matching) from
28
- AI-assisted judgment, so the parts that can be verified mechanically are verified mechanically.
29
- - Keeps private project data and public toolkit code in separate places by construction.
86
+ - 🔎 **Grounds every material claim** in cited evidence pulled from *your* project's own corpus —
87
+ not from the model's general knowledge about "systems like this."
88
+ - ⚖️ **Treats AI as a hypothesis, not a default.** Every proposed AI feature is compared against the
89
+ simplest viable non-AI alternative before it's recommended.
90
+ - 🧮 **Separates deterministic checks from AI judgment.** Feasibility-score arithmetic, the
91
+ non-overridable security-blocker rule, presentation-rule matching, Markdown rendering, and secret
92
+ scanning are all plain, tested Node.js code — not left to a model to "probably get right."
93
+ - 🔒 **Keeps private project data and public toolkit code structurally separate** — nothing you feed
94
+ it ends up in this repository, and a release-audit script scans for secrets/paths before anything
95
+ is ever published.
96
+ - 🧩 **Composable, not monolithic.** Ten independent skills you can mix and match, each with its own
97
+ purpose, inputs, outputs, evidence rules, and anti-fabrication rules.
30
98
 
31
99
  ## Quick start
32
100
 
33
101
  ```bash
34
- # List the available skills
102
+ # Clone it
103
+ git clone https://github.com/ThanbirTamim/enterprise-project-intelligence.git
104
+ cd enterprise-project-intelligence
105
+
106
+ # Or install the published package
107
+ npm install -g @thanbir-tamim/enterprise-project-intelligence-agent
108
+
109
+ # See what's inside
35
110
  node scripts/cli.mjs list
36
111
 
37
- # Validate skill structure (frontmatter, required sections, referenced files exist)
112
+ # Validate skill structure (frontmatter, required sections, referenced files all exist)
38
113
  node scripts/cli.mjs validate
39
114
 
40
- # Inventory a documentation corpus (reports counts; see the skill for persisted output)
115
+ # Point it at a real documentation corpus (writes to a private directory, never into this repo)
41
116
  node scripts/cli.mjs inventory /path/to/your/project/docs --out ./.local-knowledge/my-project
42
117
 
43
- # Run the public-release confidentiality/secret audit over this repository
118
+ # Run the full test suite
119
+ npm test
120
+
121
+ # Run the public-release confidentiality/secret audit
44
122
  node scripts/cli.mjs release-audit
45
123
  ```
46
124
 
47
- Then point your AI coding agent (one that supports the Agent Skills convention — each skill is a
48
- `SKILL.md` with YAML frontmatter) at the `skills/` directory, or install individual skill folders
49
- into your agent's skills directory. Start with `project-documentation-discovery`, then
125
+ Then point your AI coding agent at the `skills/` directory (or copy individual `skills/<name>/`
126
+ folders into your agent's own skills directory). Start with `project-documentation-discovery`, then
50
127
  `software-reverse-engineering` and/or `project-knowledge-assistant`, then
51
- `enterprise-ai-integration-planner`.
128
+ `enterprise-ai-integration-planner`. Full walkthrough in [`docs/USER_GUIDE.md`](docs/USER_GUIDE.md).
129
+
130
+ ---
131
+
132
+ ## The 10 skills, in detail
133
+
134
+ Each skill is a self-contained `SKILL.md` (purpose, required inputs, execution procedure, expected
135
+ outputs, evidence requirements, anti-fabrication rules, error handling, security considerations) plus
136
+ `references/` material and, where determinism matters, a tested `scripts/*.mjs` helper.
137
+
138
+ ### 1. 📂 `project-documentation-discovery`
139
+ **The entry point for any new project.** Walks a documentation/code corpus, classifies every file by
140
+ format, extracts headings/tables/structure for what it can genuinely parse (Markdown, text, JSON,
141
+ YAML, CSV, HTML), and **honestly** flags what it can't (DOCX/PPTX/PDF/Keynote/Pages) instead of
142
+ silently skipping or falsely claiming success.
143
+ - **Inputs**: a corpus path, optional project profile (confidentiality level, excluded paths).
144
+ - **Outputs**: `inventory.json`, `evidence-index.json`, `INVENTORY_SUMMARY.md`.
145
+ - **Reference script**: [`scripts/inventory.mjs`](skills/project-documentation-discovery/scripts/inventory.mjs) — zero dependencies, redacts secret-shaped strings before indexing.
146
+
147
+ ### 2. 💬 `project-knowledge-assistant`
148
+ Answers questions about the target project **strictly from the evidence index** — every material
149
+ claim is cited with a `source_location`, every inference is labeled as an inference, and
150
+ contradictions between sources are surfaced, never silently resolved.
151
+ - **Inputs**: evidence index + the user's question.
152
+ - **Outputs**: a cited answer, confidence labels (`documented` / `verified-in-code` / `inferred` /
153
+ `unverified-claim` / `superseded`), or an explicit "not found in the evidence."
154
+
155
+ ### 3. 🏗️ `software-reverse-engineering`
156
+ Reconstructs architecture, modules, APIs, data model, and workflows from whatever evidence is
157
+ available — reconciling documentation against actual code when both exist, and clearly separating
158
+ `verified-in-code` facts from `documented-only` claims from honest inferences.
159
+ - **Outputs**: module map, API/route inventory, data model summary, workflow reconstructions,
160
+ documentation-vs-code discrepancy list, and an explicit "could not verify" section.
161
+
162
+ ### 4. 🤖 `enterprise-ai-integration-planner` — the flagship skill
163
+ Discovers, scores, and plans **AI integration opportunities for any project — including ones with
164
+ zero existing AI.** Every proposal is compared against the simplest non-AI alternative first. Scoring
165
+ is an eight-dimension, published weighting formula with a **non-overridable blocker rule**: a critical
166
+ security/privacy/legal/authorization blocker forces `blocked`/`rework-required` *no matter how high
167
+ the weighted score is* — enforced in code, not just prose, and covered by automated tests.
168
+
169
+ <p align="center">
170
+ <img src="assets/figures/feasibility-scoring-engine.png" alt="Feasibility Scoring and Blocker Override Engine" width="90%">
171
+ </p>
172
+
173
+ - **Reference script**: [`scripts/score-opportunity.mjs`](skills/enterprise-ai-integration-planner/scripts/score-opportunity.mjs) — pure function, fully reproducible.
174
+ - **Generates**: `AI_INTEGRATION_STRATEGY.md`, `AI_OPPORTUNITY_MATRIX.md`, `AI_FEASIBILITY_ASSESSMENT.md`,
175
+ `AI_REFERENCE_ARCHITECTURE.md`, `AI_SECURITY_AND_GOVERNANCE.md`, `AI_EVALUATION_FRAMEWORK.md`,
176
+ `AI_IMPLEMENTATION_ROADMAP.md`, `AI_PILOT_PROPOSAL.md`, `AI_INTEGRATION_FAQ.md`, a risk register,
177
+ and a pilot acceptance checklist.
178
+ - **Try it**: [`examples/synthetic-inventory-system/ai-opportunity-matrix/`](examples/synthetic-inventory-system/ai-opportunity-matrix/AI_OPPORTUNITY_MATRIX.md) — a fully worked, fictional example, including a reproducible score showing the blocker rule in action.
179
+
180
+ ### 5. 🖼️ `corporate-presentation-generator`
181
+ Builds evidence-backed slide decks from project evidence, against **your** supplied corporate
182
+ guidelines (or a neutral, original default style guide — never a real company's proprietary rules).
183
+ Every factual slide is cited or explicitly labeled illustrative.
184
+
185
+ ### 6. ✅ `presentation-compliance-validator`
186
+ Converts configurable presentation guidelines into structured rules and validates a deck against
187
+ them — **specific, itemized violations and corrective actions**, never a vague aggregate score.
188
+ Honestly reports `not-checkable-from-this-format` rather than guessing a pass when the deck
189
+ representation doesn't expose a property (e.g., no color/font metadata).
190
+ - **Reference script**: [`scripts/validate-deck.mjs`](skills/presentation-compliance-validator/scripts/validate-deck.mjs).
191
+
192
+ ### 7. 📄 `technical-document-generator`
193
+ Renders structured findings from the other skills into consistent Markdown/HTML artifacts (DOCX/PPTX
194
+ only through a verified exporter — never claimed without one), preserving every citation attached to
195
+ the source finding.
196
+ - **Reference script**: [`scripts/render-markdown-to-html.mjs`](skills/technical-document-generator/scripts/render-markdown-to-html.mjs) — a dependency-free Markdown → HTML renderer.
197
+
198
+ ### 8. 🩺 `documentation-quality-auditor`
199
+ Finds contradictions, stale documents, broken internal references, missing required sections, and
200
+ unsupported claims across a documentation corpus — always reporting both sides of a contradiction,
201
+ never auto-resolving.
202
+
203
+ ### 9. 🌊 `software-change-impact-analyzer`
204
+ Traces the likely effects of a proposed change across modules, APIs, workflows, tests, data entities,
205
+ and documentation — scoping confidence honestly (first-order impacts vs. lower-confidence second-order
206
+ effects) rather than implying full coverage.
207
+
208
+ ### 10. 🎓 `engineering-knowledge-transfer`
209
+ Generates onboarding guides, operational runbooks, handover documents, and troubleshooting guides
210
+ from the same evidence base — with explicit `TODO: confirm with current operator` markers instead of
211
+ fabricated procedures when the evidence doesn't cover something.
212
+
213
+ > 📑 One-page table version: [`docs/SKILL_CATALOG.md`](docs/SKILL_CATALOG.md). Live version straight
214
+ > from each skill's frontmatter: `node scripts/cli.mjs list`.
215
+
216
+ ---
52
217
 
53
218
  ## Repository layout
54
219
 
@@ -62,32 +227,120 @@ tests/ Automated tests (node:test) using synthetic fixt
62
227
  evaluations/ Evaluation guide placeholders for AI-assisted review quality
63
228
  ```
64
229
 
65
- See `docs/SKILL_CATALOG.md` for a one-page summary of every skill, and
66
- `docs/IMPLEMENTATION_REPORT.md` for the full implementation report.
67
-
68
230
  ## Confidentiality by construction
69
231
 
70
- This toolkit was developed using private reference material to understand real-world requirements,
71
- but:
72
-
73
232
  - No internal project name, organization name, proprietary feature, internal URL, file path, or
74
233
  employee name appears anywhere in this repository.
75
- - All examples use a fictional "synthetic inventory management platform."
76
- - The default presentation style guide is original, neutral, placeholder-branded content — not any
77
- company's proprietary guideline.
78
- - `scripts/release-audit.mjs` scans for secret-shaped values, local filesystem paths, and
79
- configurable private terms before any release, reporting file/line/category **without printing
80
- the matched value**. This is a safeguard, not a guarantee — human review is still required before
81
- publishing anything derived from a real project.
234
+ - All examples use a fictional **"Synthetic Inventory Platform."**
235
+ - The default presentation style guide is original, neutral, placeholder-branded content.
236
+ - [`scripts/release-audit.mjs`](scripts/release-audit.mjs) scans for secret-shaped values, local
237
+ filesystem paths, and configurable private terms before any release — reporting **file, line, and
238
+ category only, never the matched value.** Safeguard, not a guarantee; human review is still
239
+ required.
240
+
241
+ ## Testing & validation
242
+
243
+ ```bash
244
+ npm test # 42/42 passing — node:test, zero test-framework dependency
245
+ npm run validate # structural validation of every skill
246
+ npm run release-audit # secret/path scan before any release
247
+ npm run pack:dry-run # inspect exactly what would be published
248
+ ```
249
+
250
+ See [`docs/TESTING_STRATEGY.md`](docs/TESTING_STRATEGY.md) for what's covered automatically versus
251
+ what needs human/AI-assisted review ([`docs/EVALUATION_GUIDE.md`](docs/EVALUATION_GUIDE.md)).
252
+
253
+ ## Performance evaluation
254
+
255
+ The toolkit ships with a reproducible evaluation harness (`evaluations/`). Results below are from
256
+ that harness; project-specific raw outputs are never committed (see the confidentiality note).
257
+
258
+ ### Deterministic correctness (synthetic fixtures)
259
+
260
+ | Check | Result |
261
+ |---|---|
262
+ | Deterministic functional tests (`evaluations/harness/run-deterministic-evals.mjs`) | **84 / 84 pass** |
263
+ | Repository unit/regression tests (`npm test`) | **42 / 42 pass** |
264
+ | Skill-structure validation | **0 errors** across all 10 skills |
265
+ | Release audit on the published package | **0 findings** |
266
+
267
+ ### With-skill vs. without-skill (A/B, synthetic benchmark)
268
+
269
+ Same model, same inputs, graded against rubrics fixed before the runs
270
+ (`evaluations/datasets/`):
271
+
272
+ | | Without skill | With skill |
273
+ |---|:--:|:--:|
274
+ | Rubric score | 39 / 43 (91%) | **43 / 43 (100%)** |
275
+ | Regressions | — | **0** |
276
+
277
+ The skill arm's gains show up as consistent citations, confidence labels, non-AI-first comparisons,
278
+ confidentiality handling, and TODO markers, at a token-cost premium. Real activation (an agent
279
+ loading the right skill for a request) scored **22 / 22** across 12 positive and 10 negative prompts.
280
+
281
+ ### Scale & robustness (real-world codebase)
282
+
283
+ Validated against a real-world **Vue + Laravel enterprise codebase** (~5,900 non-vendor source files
284
+ across PHP/TypeScript/Vue, ~1.9 GB) to confirm the deterministic skills hold at scale. Aggregate,
285
+ anonymized metrics only — no project data is included in this package:
286
+
287
+ | Metric | Result |
288
+ |---|---|
289
+ | Files inventoried by `project-documentation-discovery` | 5,904 in **2.07 s**, peak **267 MB** RAM |
290
+ | Unsupported/binary formats | correctly flagged (not silently skipped) |
291
+ | Secret-like values | redacted and recorded by file/line, values never emitted |
292
+ | `documentation-quality-auditor` precision fix | contradiction false-positives on templated/series content reduced from thousands to **0**, with real cross-document contradictions still detected |
293
+
294
+ A with-skill vs. without-skill A/B on that codebase's functional documentation (4 queries x 2 arms,
295
+ run strictly sequentially) scored **71% -> 100%** rubric compliance: without the skill the model
296
+ mislabeled documented-only facts as verified, skipped reproducibility/limits disclosure, and applied
297
+ no transparent feasibility scoring; the skill arm corrected all of these with no regressions.
298
+ (Per the confidentiality policy, the project's queries and responses are kept private; only these
299
+ aggregate numbers are published.)
300
+
301
+ > Per-skill 0–5 scores and methodology: [`evaluations/SKILLS_EVALUATION_REPORT.md`](evaluations/SKILLS_EVALUATION_REPORT.md)
302
+ > (overall **4.76 / 5**, every skill ≥ 4.5). The harness is memory-bounded; run any LLM-based A/B in
303
+ > small sequential batches, not all at once.
304
+
305
+
306
+ ## Installation
307
+
308
+ Full instructions: [`docs/INSTALLATION.md`](docs/INSTALLATION.md) · [`docs/QUICK_START.md`](docs/QUICK_START.md)
309
+
310
+ ```bash
311
+ npm install -g @thanbir-tamim/enterprise-project-intelligence-agent
312
+ epi-agent list
313
+ ```
314
+
315
+ ## Documentation
316
+
317
+ | Doc | What's in it |
318
+ |---|---|
319
+ | [`docs/USER_GUIDE.md`](docs/USER_GUIDE.md) | End-to-end workflow across all 10 skills |
320
+ | [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) | Design principles, component map |
321
+ | [`docs/SKILL_CATALOG.md`](docs/SKILL_CATALOG.md) | One-page skill reference table |
322
+ | [`docs/KNOWLEDGE_MODEL.md`](docs/KNOWLEDGE_MODEL.md) · [`docs/EVIDENCE_AND_PROVENANCE.md`](docs/EVIDENCE_AND_PROVENANCE.md) | How evidence/citations work |
323
+ | [`docs/SUPPORTED_FORMATS.md`](docs/SUPPORTED_FORMATS.md) | What's actually tested vs. aspirational |
324
+ | [`docs/SECURITY_MODEL.md`](docs/SECURITY_MODEL.md) | Threat model + safeguards |
325
+ | [`docs/IMPLEMENTATION_REPORT.md`](docs/IMPLEMENTATION_REPORT.md) | Full build report: what was implemented, tested, verified |
326
+ | [`docs/TROUBLESHOOTING.md`](docs/TROUBLESHOOTING.md) | Common issues and fixes |
82
327
 
83
328
  ## Status
84
329
 
85
- Published on npm as `@thanbir-tamim/enterprise-project-intelligence-agent` (see `package.json` for
86
- the current version). This is an early release (`0.1.x`) — see `docs/IMPLEMENTATION_REPORT.md` for
87
- what has been implemented, tested, and verified so far, and `CHANGELOG.md` for release history.
88
- Future releases are published deliberately, never automatically, following the checklist in
89
- `docs/INSTALLATION.md`.
330
+ Published on npm as
331
+ [`@thanbir-tamim/enterprise-project-intelligence-agent`](https://www.npmjs.com/package/@thanbir-tamim/enterprise-project-intelligence-agent).
332
+ See [`CHANGELOG.md`](CHANGELOG.md) for release history and
333
+ [`docs/IMPLEMENTATION_REPORT.md`](docs/IMPLEMENTATION_REPORT.md) for the detailed build/verification
334
+ report. Future releases are published deliberately, never automatically, following the checklist in
335
+ [`docs/INSTALLATION.md`](docs/INSTALLATION.md).
336
+
337
+ ## Contributing & license
338
+
339
+ Contributions welcome — see [`CONTRIBUTING.md`](CONTRIBUTING.md) (ground rule #1: no confidential
340
+ content, ever) and [`SECURITY.md`](SECURITY.md) for vulnerability reporting.
341
+
342
+ Licensed under [Apache-2.0](LICENSE).
90
343
 
91
- ## License
344
+ ---
92
345
 
93
- Apache-2.0 — see `LICENSE`.
346
+ <p align="center"><em>Built for engineers who want an honest answer to "where should AI go in this system?" — including when the honest answer is "nowhere, yet."</em></p>
@@ -10,10 +10,10 @@ rationale per format.
10
10
  | Markdown | Verified |
11
11
  | Plain text | Verified |
12
12
  | JSON | Verified |
13
- | YAML | Verified (subset) |
14
- | CSV | Verified |
15
- | HTML (headings/tables) | Verified (subset — no CSS/JS rendering) |
16
- | Source code / config files | Verified (treated as text) |
13
+ | YAML | Verified (syntax check only; `extracted-partial`) |
14
+ | CSV | Verified (quote-aware) |
15
+ | HTML (headings/tables) | Verified (subset; always `extracted-partial`) |
16
+ | Source code / config files | Verified (treated as text; secret-scanned) |
17
17
  | Images / screenshots | Catalogued only (no OCR); flagged for manual review |
18
18
  | DOCX | Unsupported in the bundled reference implementation (requires an optional dependency) |
19
19
  | PPTX | Unsupported in the bundled reference implementation (requires an optional dependency) |
@@ -9,8 +9,8 @@
9
9
  | Field | Value |
10
10
  |---|---|
11
11
  | Target module / workflow | Receiving |
12
- | Current behavior | Associate manually re-keys packing-slip quantities into the Receiving screen [source: receiving-workflow.md#2-steps]. |
13
- | User problem | Manual re-keying causes typos and stock mismatches [source: overview.md#3-known-pain-points-fictional-for-demonstration-only]. |
12
+ | Current behavior | Associate manually re-keys packing-slip quantities into the Receiving screen [source: source-docs/receiving-workflow.md#2-steps]. |
13
+ | User problem | Manual re-keying causes typos and stock mismatches [source: source-docs/overview.md#3-known-pain-points-fictional-for-demonstration-only]. |
14
14
  | Proposed capability | Extract line-item quantities from a scanned/photographed packing slip and pre-fill the Receiving form for associate confirmation. |
15
15
  | Proposed integration point | New "suggested receipt" step before the existing manual-entry step; associate still confirms/edits before submission. |
16
16
  | Required data | Scanned packing slip images; existing PO line items for cross-checking. |
@@ -36,7 +36,7 @@ node skills/enterprise-ai-integration-planner/scripts/score-opportunity.mjs \
36
36
  | Field | Value |
37
37
  |---|---|
38
38
  | Target module / workflow | Reporting |
39
- | Current behavior | A staff member reads a weekly CSV report to decide on reorders [source: overview.md#3-known-pain-points-fictional-for-demonstration-only]. |
39
+ | Current behavior | A staff member reads a weekly CSV report to decide on reorders [source: source-docs/overview.md#3-known-pain-points-fictional-for-demonstration-only]. |
40
40
  | User problem | Delay between stock dropping below reorder point and a human noticing it. |
41
41
  | Proposed capability | Deterministic rule: alert when `current_quantity < reorder_point` (see `sample-catalog.csv`). |
42
42
  | Non-AI alternative | **This is the recommended solution.** A scheduled job comparing quantity to reorder point is a complete, lower-risk fit — no AI technique is needed here. |
@@ -49,7 +49,7 @@ node skills/enterprise-ai-integration-planner/scripts/score-opportunity.mjs \
49
49
  | Field | Value |
50
50
  |---|---|
51
51
  | Target module / workflow | Purchase Orders |
52
- | Current behavior | Support staff search old email threads to answer "why was this PO changed" [source: overview.md#3-known-pain-points-fictional-for-demonstration-only]. |
52
+ | Current behavior | Support staff search old email threads to answer "why was this PO changed" [source: source-docs/overview.md#3-known-pain-points-fictional-for-demonstration-only]. |
53
53
  | Proposed capability | A RAG-style assistant over structured PO change logs (once such logs exist) producing cited explanations. |
54
54
  | Non-AI alternative | First, simply start recording structured change history (who/when/what/why) on every PO edit — this alone may resolve most of the problem without any AI component. |
55
55
  | AI technique | Retrieval-augmented generation, recommended only after structured change history exists. |
@@ -0,0 +1,17 @@
1
+ # Inventory summary
2
+
3
+ Corpus: `source-docs`
4
+ Total files: 3
5
+
6
+ ## By status
7
+ - extracted-full: 3
8
+
9
+ ## By type
10
+ - markdown: 2
11
+ - csv: 1
12
+
13
+ ## Files needing manual/visual review
14
+ - none
15
+
16
+ ## Redacted secret-like values
17
+ - none
@@ -0,0 +1,78 @@
1
+ [
2
+ {
3
+ "source_path": "overview.md",
4
+ "source_location": "overview.md#synthetic-inventory-platform--overview",
5
+ "heading_path": "Synthetic Inventory Platform — Overview",
6
+ "evidence_type": "text",
7
+ "level": 1
8
+ },
9
+ {
10
+ "source_path": "overview.md",
11
+ "source_location": "overview.md#1-purpose",
12
+ "heading_path": "1. Purpose",
13
+ "evidence_type": "text",
14
+ "level": 2
15
+ },
16
+ {
17
+ "source_path": "overview.md",
18
+ "source_location": "overview.md#2-modules",
19
+ "heading_path": "2. Modules",
20
+ "evidence_type": "text",
21
+ "level": 2
22
+ },
23
+ {
24
+ "source_path": "overview.md",
25
+ "source_location": "overview.md#3-known-pain-points-fictional-for-demonstration-only",
26
+ "heading_path": "3. Known pain points (fictional, for demonstration only)",
27
+ "evidence_type": "text",
28
+ "level": 2
29
+ },
30
+ {
31
+ "source_path": "receiving-workflow.md",
32
+ "source_location": "receiving-workflow.md#receiving-workflow-fictional",
33
+ "heading_path": "Receiving Workflow (fictional)",
34
+ "evidence_type": "text",
35
+ "level": 1
36
+ },
37
+ {
38
+ "source_path": "receiving-workflow.md",
39
+ "source_location": "receiving-workflow.md#1-trigger",
40
+ "heading_path": "1. Trigger",
41
+ "evidence_type": "text",
42
+ "level": 2
43
+ },
44
+ {
45
+ "source_path": "receiving-workflow.md",
46
+ "source_location": "receiving-workflow.md#2-steps",
47
+ "heading_path": "2. Steps",
48
+ "evidence_type": "text",
49
+ "level": 2
50
+ },
51
+ {
52
+ "source_path": "receiving-workflow.md",
53
+ "source_location": "receiving-workflow.md#3-business-rules",
54
+ "heading_path": "3. Business rules",
55
+ "evidence_type": "text",
56
+ "level": 2
57
+ },
58
+ {
59
+ "source_path": "receiving-workflow.md",
60
+ "source_location": "receiving-workflow.md#4-known-limitation",
61
+ "heading_path": "4. Known limitation",
62
+ "evidence_type": "text",
63
+ "level": 2
64
+ },
65
+ {
66
+ "source_path": "sample-catalog.csv",
67
+ "source_location": "sample-catalog.csv#table",
68
+ "heading_path": "table (4 rows, columns: item_sku|description|category|reorder_point|current_quantity)",
69
+ "evidence_type": "table",
70
+ "columns": [
71
+ "item_sku",
72
+ "description",
73
+ "category",
74
+ "reorder_point",
75
+ "current_quantity"
76
+ ]
77
+ }
78
+ ]
@@ -0,0 +1,26 @@
1
+ [
2
+ {
3
+ "path": "overview.md",
4
+ "type": "markdown",
5
+ "title": "Synthetic Inventory Platform — Overview",
6
+ "status": "extracted-full",
7
+ "hash": "d69cab662c1414eaab7216212eb74c36edfc37df62962e5206c30ac64f931158",
8
+ "warnings": []
9
+ },
10
+ {
11
+ "path": "receiving-workflow.md",
12
+ "type": "markdown",
13
+ "title": "Receiving Workflow (fictional)",
14
+ "status": "extracted-full",
15
+ "hash": "b50e0bf4cfbbec5a26ba3c747444466b8d7fe3ea47e2b3df434e6b2fe4589805",
16
+ "warnings": []
17
+ },
18
+ {
19
+ "path": "sample-catalog.csv",
20
+ "type": "csv",
21
+ "title": "sample-catalog.csv",
22
+ "status": "extracted-full",
23
+ "hash": "73183970de5e9582dabb645c9508c6c5064f8f11af36f9ba47245d1fc26a4762",
24
+ "warnings": []
25
+ }
26
+ ]