@thanbir-tamim/enterprise-project-intelligence-agent 0.0.0-stage → 0.1.1
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/CHANGELOG.md +29 -0
- package/LICENSE +201 -0
- package/NOTICE +7 -0
- package/README.md +92 -2
- package/SECURITY.md +23 -0
- package/docs/ARCHITECTURE.md +43 -0
- package/docs/DOCUMENT_INGESTION.md +40 -0
- package/docs/EVALUATION_GUIDE.md +36 -0
- package/docs/EVIDENCE_AND_PROVENANCE.md +40 -0
- package/docs/IMPLEMENTATION_REPORT.md +209 -0
- package/docs/INSTALLATION.md +46 -0
- package/docs/KNOWLEDGE_MODEL.md +45 -0
- package/docs/MAINTENANCE.md +30 -0
- package/docs/QUICK_START.md +27 -0
- package/docs/SECURITY_MODEL.md +34 -0
- package/docs/SKILL_CATALOG.md +17 -0
- package/docs/SUPPORTED_FORMATS.md +25 -0
- package/docs/TESTING_STRATEGY.md +41 -0
- package/docs/TROUBLESHOOTING.md +35 -0
- package/docs/USER_GUIDE.md +41 -0
- package/examples/synthetic-inventory-system/ai-opportunity-matrix/AI_OPPORTUNITY_MATRIX.md +65 -0
- package/examples/synthetic-inventory-system/presentation/COMPLIANCE_REPORT.json +34 -0
- package/examples/synthetic-inventory-system/presentation/DEMO_DECK.md +129 -0
- package/examples/synthetic-inventory-system/presentation/demo-deck.json +20 -0
- package/examples/synthetic-inventory-system/source-docs/overview.md +26 -0
- package/examples/synthetic-inventory-system/source-docs/receiving-workflow.md +23 -0
- package/examples/synthetic-inventory-system/source-docs/sample-catalog.csv +5 -0
- package/package.json +51 -4
- package/scripts/cli.mjs +86 -0
- package/scripts/lib/skills.mjs +118 -0
- package/scripts/release-audit.mjs +119 -0
- package/skills/corporate-presentation-generator/SKILL.md +93 -0
- package/skills/corporate-presentation-generator/references/default-style-guide.md +37 -0
- package/skills/corporate-presentation-generator/references/slide-content-patterns.md +10 -0
- package/skills/documentation-quality-auditor/SKILL.md +87 -0
- package/skills/documentation-quality-auditor/references/audit-checks.md +13 -0
- package/skills/documentation-quality-auditor/scripts/audit-docs.mjs +52 -0
- package/skills/engineering-knowledge-transfer/SKILL.md +73 -0
- package/skills/engineering-knowledge-transfer/references/learning-path-patterns.md +18 -0
- package/skills/enterprise-ai-integration-planner/SKILL.md +181 -0
- package/skills/enterprise-ai-integration-planner/references/adoption-roadmap.md +46 -0
- package/skills/enterprise-ai-integration-planner/references/architecture-alternatives.md +27 -0
- package/skills/enterprise-ai-integration-planner/references/feasibility-scoring.md +61 -0
- package/skills/enterprise-ai-integration-planner/references/opportunity-catalog.md +62 -0
- package/skills/enterprise-ai-integration-planner/references/security-patterns.md +36 -0
- package/skills/enterprise-ai-integration-planner/scripts/score-opportunity.mjs +101 -0
- package/skills/presentation-compliance-validator/SKILL.md +89 -0
- package/skills/presentation-compliance-validator/references/rule-schema.md +24 -0
- package/skills/presentation-compliance-validator/scripts/validate-deck.mjs +122 -0
- package/skills/project-documentation-discovery/SKILL.md +141 -0
- package/skills/project-documentation-discovery/references/extraction-checklist.md +22 -0
- package/skills/project-documentation-discovery/references/format-matrix.md +30 -0
- package/skills/project-documentation-discovery/scripts/inventory.mjs +213 -0
- package/skills/project-knowledge-assistant/SKILL.md +89 -0
- package/skills/project-knowledge-assistant/references/citation-format.md +14 -0
- package/skills/project-knowledge-assistant/references/confidence-levels.md +11 -0
- package/skills/software-change-impact-analyzer/SKILL.md +73 -0
- package/skills/software-change-impact-analyzer/references/impact-dimensions.md +10 -0
- package/skills/software-reverse-engineering/SKILL.md +99 -0
- package/skills/software-reverse-engineering/references/architecture-diagram-notation.md +12 -0
- package/skills/software-reverse-engineering/references/reconstruction-method.md +11 -0
- package/skills/technical-document-generator/SKILL.md +77 -0
- package/skills/technical-document-generator/references/document-structure.md +23 -0
- package/skills/technical-document-generator/scripts/render-markdown-to-html.mjs +93 -0
- package/templates/AI_OPPORTUNITY_MATRIX.template.md +32 -0
- package/templates/AI_PILOT_PROPOSAL.template.md +41 -0
- package/templates/presentation-rules.example.json +20 -0
- package/templates/project-profile.example.yaml +18 -0
- package/templates/risk-register.template.md +8 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.1.1
|
|
4
|
+
|
|
5
|
+
- Fixed stale README "Status" section (incorrectly said "unpublished" after the package was
|
|
6
|
+
published to npm).
|
|
7
|
+
- No functional changes to skills or scripts.
|
|
8
|
+
|
|
9
|
+
## 0.1.0 — Initial public release
|
|
10
|
+
|
|
11
|
+
- Added 10 composable Agent Skills: `project-documentation-discovery`,
|
|
12
|
+
`project-knowledge-assistant`, `software-reverse-engineering`,
|
|
13
|
+
`enterprise-ai-integration-planner`, `corporate-presentation-generator`,
|
|
14
|
+
`presentation-compliance-validator`, `technical-document-generator`,
|
|
15
|
+
`documentation-quality-auditor`, `software-change-impact-analyzer`,
|
|
16
|
+
`engineering-knowledge-transfer`.
|
|
17
|
+
- Added reusable, dependency-free Node.js scripts: documentation inventory, feasibility scoring,
|
|
18
|
+
presentation compliance validation, Markdown-to-HTML rendering, and a public-release audit
|
|
19
|
+
(secret-shaped value + local-path scanning).
|
|
20
|
+
- Added blank templates for the AI opportunity matrix, pilot proposal, and risk register, plus a
|
|
21
|
+
generic presentation-rules schema example.
|
|
22
|
+
- Added a fully synthetic worked example (`examples/synthetic-inventory-system/`).
|
|
23
|
+
- Added automated tests (`node:test`) covering skill structure validation, inventory extraction,
|
|
24
|
+
feasibility scoring (including the non-overridable blocker rule), presentation compliance
|
|
25
|
+
checking, Markdown rendering, and release-audit secret detection.
|
|
26
|
+
- Added toolkit documentation under `docs/`.
|
|
27
|
+
- Not yet published to any package registry at the time this entry was written. See
|
|
28
|
+
`docs/IMPLEMENTATION_REPORT.md` for status and
|
|
29
|
+
the release-preparation checklist.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 GobeshonaLabAgent contributors
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Apache License 2.0
|
|
2
|
+
|
|
3
|
+
Copyright 2024 Thanbir Tamim
|
|
4
|
+
|
|
5
|
+
This product includes the "Enterprise Project Intelligence & AI Integration Agent" Agent Skills
|
|
6
|
+
toolkit, developed independently as a project-agnostic, organization-agnostic resource. No third
|
|
7
|
+
party's proprietary content, branding, or confidential project data is included.
|
package/README.md
CHANGED
|
@@ -1,3 +1,93 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Enterprise Project Intelligence & AI Integration Agent
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A project-agnostic, organization-agnostic **Agent Skills toolkit** that helps an AI assistant:
|
|
4
|
+
|
|
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.
|
|
15
|
+
|
|
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**.
|
|
19
|
+
|
|
20
|
+
## Why this exists
|
|
21
|
+
|
|
22
|
+
Most "apply AI to my project" advice is generic. This toolkit instead:
|
|
23
|
+
|
|
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.
|
|
30
|
+
|
|
31
|
+
## Quick start
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# List the available skills
|
|
35
|
+
node scripts/cli.mjs list
|
|
36
|
+
|
|
37
|
+
# Validate skill structure (frontmatter, required sections, referenced files exist)
|
|
38
|
+
node scripts/cli.mjs validate
|
|
39
|
+
|
|
40
|
+
# Inventory a documentation corpus (reports counts; see the skill for persisted output)
|
|
41
|
+
node scripts/cli.mjs inventory /path/to/your/project/docs --out ./.local-knowledge/my-project
|
|
42
|
+
|
|
43
|
+
# Run the public-release confidentiality/secret audit over this repository
|
|
44
|
+
node scripts/cli.mjs release-audit
|
|
45
|
+
```
|
|
46
|
+
|
|
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
|
|
50
|
+
`software-reverse-engineering` and/or `project-knowledge-assistant`, then
|
|
51
|
+
`enterprise-ai-integration-planner`.
|
|
52
|
+
|
|
53
|
+
## Repository layout
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
skills/ 10 composable Agent Skills (SKILL.md + references/ + scripts/)
|
|
57
|
+
templates/ Blank, reusable templates (opportunity matrix, pilot proposal, ...)
|
|
58
|
+
examples/synthetic-inventory-system/ Fully synthetic worked example (fictional data only)
|
|
59
|
+
scripts/ Reusable, dependency-free Node.js CLI + libraries
|
|
60
|
+
docs/ Toolkit documentation (ingestion, security model, catalog, ...)
|
|
61
|
+
tests/ Automated tests (node:test) using synthetic fixtures only
|
|
62
|
+
evaluations/ Evaluation guide placeholders for AI-assisted review quality
|
|
63
|
+
```
|
|
64
|
+
|
|
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
|
+
## Confidentiality by construction
|
|
69
|
+
|
|
70
|
+
This toolkit was developed using private reference material to understand real-world requirements,
|
|
71
|
+
but:
|
|
72
|
+
|
|
73
|
+
- No internal project name, organization name, proprietary feature, internal URL, file path, or
|
|
74
|
+
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.
|
|
82
|
+
|
|
83
|
+
## Status
|
|
84
|
+
|
|
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`.
|
|
90
|
+
|
|
91
|
+
## License
|
|
92
|
+
|
|
93
|
+
Apache-2.0 — see `LICENSE`.
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Reporting a vulnerability
|
|
4
|
+
|
|
5
|
+
If you believe you've found a security issue in this toolkit (e.g., a prompt-injection bypass in a
|
|
6
|
+
skill's instructions, a secret-scanning gap in `scripts/release-audit.mjs`, or a path-traversal issue
|
|
7
|
+
in the inventory scripts), please open a private report through the repository's security advisory
|
|
8
|
+
feature rather than a public issue, and avoid including any real confidential data in the report.
|
|
9
|
+
|
|
10
|
+
## Scope and limitations
|
|
11
|
+
|
|
12
|
+
- This toolkit's `scripts/release-audit.mjs` is a **safeguard, not a guarantee**. It performs
|
|
13
|
+
pattern-based scanning for secret-shaped values and local filesystem paths; it cannot prove the
|
|
14
|
+
complete absence of confidential content. Human review is required before any release.
|
|
15
|
+
- Skills in `skills/` are instructions for an AI agent, not sandboxed code; they rely on the host
|
|
16
|
+
agent's own tool permissions and sandboxing for actual file/network access.
|
|
17
|
+
- No skill in this toolkit should be configured to let an AI agent bypass an existing application's
|
|
18
|
+
authentication/authorization or take irreversible actions without human approval — see
|
|
19
|
+
`skills/enterprise-ai-integration-planner/references/security-patterns.md`.
|
|
20
|
+
|
|
21
|
+
## Supported versions
|
|
22
|
+
|
|
23
|
+
Only the latest `main` branch state is supported while this project is pre-1.0 and unpublished.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
## Design principles
|
|
4
|
+
|
|
5
|
+
- **Skills are instructions, not a runtime.** Each `skills/<name>/SKILL.md` tells an AI agent what
|
|
6
|
+
to do, when, with what inputs, and what evidence/anti-fabrication rules apply. The agent (not this
|
|
7
|
+
repository) performs file access, model inference, and tool calls, subject to its own permissions.
|
|
8
|
+
- **Deterministic logic lives in scripts.** Anything that can be checked mechanically (file
|
|
9
|
+
inventory, skill-structure validation, feasibility-score arithmetic and the blocker rule,
|
|
10
|
+
presentation rule checks, Markdown rendering, secret scanning) is implemented as a small,
|
|
11
|
+
dependency-free Node.js module with a corresponding test — not left to model judgment.
|
|
12
|
+
- **Model inference is optional and provider-agnostic.** No skill or script requires a specific
|
|
13
|
+
hosted LLM to run its deterministic parts. Where a skill's procedure benefits from model reasoning
|
|
14
|
+
(e.g., summarizing evidence, drafting prose), that is the responsibility of whichever AI agent is
|
|
15
|
+
running the skill; this toolkit does not bundle or call any model API itself.
|
|
16
|
+
- **Public/private separation is structural.** `.gitignore`/`.npmignore` exclude
|
|
17
|
+
`.local-knowledge/`, `.private/`, and any real project corpus by convention; skills are instructed
|
|
18
|
+
to write project-specific output outside the repository; `scripts/release-audit.mjs` double-checks
|
|
19
|
+
before any release.
|
|
20
|
+
|
|
21
|
+
## Component map
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
skills/<name>/SKILL.md Agent instructions (purpose, inputs, procedure, evidence rules)
|
|
25
|
+
skills/<name>/references/*.md Supporting reference material loaded only when relevant (progressive
|
|
26
|
+
disclosure — not everything is in SKILL.md itself)
|
|
27
|
+
skills/<name>/scripts/*.mjs Deterministic helper logic specific to that skill
|
|
28
|
+
scripts/lib/skills.mjs Shared skill discovery/validation used by scripts/cli.mjs and tests
|
|
29
|
+
scripts/cli.mjs Thin CLI: list / validate / inventory / release-audit
|
|
30
|
+
scripts/release-audit.mjs Public-release confidentiality/secret safeguard
|
|
31
|
+
templates/ Blank, reusable templates for cross-skill artifacts
|
|
32
|
+
examples/synthetic-inventory-system/ Fully fictional worked example end-to-end
|
|
33
|
+
tests/ node:test suite over the deterministic scripts and skill structure
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Why no graph database, vector database, or orchestration framework by default
|
|
37
|
+
|
|
38
|
+
Part A/B of the project brief explicitly calls for starting with a lightweight structured
|
|
39
|
+
representation and introducing heavier infrastructure only when a specific project's requirements
|
|
40
|
+
justify it. This repository follows that rule for itself: the knowledge model is plain JSON records
|
|
41
|
+
(`docs/KNOWLEDGE_MODEL.md`), and `enterprise-ai-integration-planner` applies the same anti-
|
|
42
|
+
overengineering rule when planning for the *target* project
|
|
43
|
+
(`skills/enterprise-ai-integration-planner/references/architecture-alternatives.md`).
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Document ingestion pipeline
|
|
2
|
+
|
|
3
|
+
## Goal
|
|
4
|
+
|
|
5
|
+
Turn an arbitrary folder of project documentation (and optionally source code) into a structured
|
|
6
|
+
inventory and evidence index, without ever loading the whole corpus into a single model context
|
|
7
|
+
window, and without ever claiming a format was extracted when it was only catalogued.
|
|
8
|
+
|
|
9
|
+
## Pipeline stages
|
|
10
|
+
|
|
11
|
+
1. **Enumerate** — walk the corpus, skip VCS/build directories and anything the project profile
|
|
12
|
+
excludes, record path/size/mtime/hash.
|
|
13
|
+
2. **Classify** — determine format by extension, falling back to content sniffing for ambiguous
|
|
14
|
+
extensions. See `SUPPORTED_FORMATS.md` for the authoritative support matrix.
|
|
15
|
+
3. **Extract** — run the format-appropriate extractor. Preserve heading hierarchy, page/slide
|
|
16
|
+
numbers, tables, and links. Redact secret-shaped strings before persisting.
|
|
17
|
+
4. **Classify extraction status honestly** — `extracted-full`, `extracted-partial`,
|
|
18
|
+
`unsupported-format`, or `extraction-failed`. Never upgrade a status beyond what actually
|
|
19
|
+
happened.
|
|
20
|
+
5. **Index evidence** — assign a stable `source_location` to every extracted unit (see
|
|
21
|
+
`EVIDENCE_AND_PROVENANCE.md`).
|
|
22
|
+
6. **Persist incrementally** — write results per file/batch to a private working directory (never
|
|
23
|
+
into this repository's public folders), so very large corpora do not need to fit in context at
|
|
24
|
+
once.
|
|
25
|
+
7. **Summarize** — produce `INVENTORY_SUMMARY.md` with counts by status/format and a list of files
|
|
26
|
+
needing manual/visual review.
|
|
27
|
+
|
|
28
|
+
## Reference implementation
|
|
29
|
+
|
|
30
|
+
`skills/project-documentation-discovery/scripts/inventory.mjs` implements stages 1-6 for the formats
|
|
31
|
+
marked "Verified" in `SUPPORTED_FORMATS.md`, using only Node.js built-ins. It is intentionally
|
|
32
|
+
conservative: anything it cannot genuinely parse is reported as `unsupported-format`, not silently
|
|
33
|
+
skipped or falsely marked extracted.
|
|
34
|
+
|
|
35
|
+
## Incremental processing note
|
|
36
|
+
|
|
37
|
+
For very large corpora, call the inventory function per-subdirectory or per-batch and merge results,
|
|
38
|
+
rather than attempting a single pass that must hold the entire corpus's extracted text in memory or
|
|
39
|
+
in a single prompt. The reference script's `runInventory()` function accepts a path and can be
|
|
40
|
+
invoked repeatedly against subsets of a larger tree.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Evaluation guide
|
|
2
|
+
|
|
3
|
+
## What can be checked deterministically
|
|
4
|
+
|
|
5
|
+
- Skill structure validity (`node scripts/cli.mjs validate`).
|
|
6
|
+
- Feasibility score arithmetic and blocker enforcement (`scripts/lib` + tests).
|
|
7
|
+
- Presentation rule compliance for properties the deck format actually exposes.
|
|
8
|
+
- Markdown/HTML structural well-formedness.
|
|
9
|
+
- Presence of secret-shaped values / local paths pre-release.
|
|
10
|
+
|
|
11
|
+
## What requires human or AI-assisted review
|
|
12
|
+
|
|
13
|
+
- Whether a reconstructed architecture diagram is actually accurate (requires a human familiar with
|
|
14
|
+
the real system, or a second independent pass with code access).
|
|
15
|
+
- Whether a drafted document/slide's prose is clear, well-organized, and free of subtly incorrect
|
|
16
|
+
paraphrasing of cited evidence.
|
|
17
|
+
- Visual/aesthetic presentation quality (balance, diagram clarity) — flagged by
|
|
18
|
+
`presentation-compliance-validator` as `humanReviewOnly`, never auto-passed.
|
|
19
|
+
- Whether an AI feature recommendation's business-value score is realistic for the actual
|
|
20
|
+
organization (the scoring framework structures the judgment; it does not replace it).
|
|
21
|
+
|
|
22
|
+
## Suggested evaluation loop for a real project
|
|
23
|
+
|
|
24
|
+
1. Run discovery + reverse engineering; have a human familiar with the project spot-check a sample
|
|
25
|
+
of extracted facts against the real system.
|
|
26
|
+
2. Run the AI integration planner; have the data owner and a security reviewer check the opportunity
|
|
27
|
+
matrix's data-availability and security-risk fields before any pilot starts.
|
|
28
|
+
3. For a shipped pilot, measure the metrics defined in the pilot's own `AI_EVALUATION_FRAMEWORK.md`
|
|
29
|
+
output against the baseline recorded before the pilot — never declare success without a measured
|
|
30
|
+
baseline comparison.
|
|
31
|
+
|
|
32
|
+
## Never do this
|
|
33
|
+
|
|
34
|
+
- Never treat "the model's output looked plausible" as evidence of correctness.
|
|
35
|
+
- Never skip the human spot-check step because the automated structural checks passed — structural
|
|
36
|
+
validity and factual/business correctness are different things.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Evidence and provenance model
|
|
2
|
+
|
|
3
|
+
Every fact this toolkit's skills state about a target project must be traceable to a
|
|
4
|
+
`source_location`, or explicitly labeled as inference/unverified.
|
|
5
|
+
|
|
6
|
+
## Evidence record shape
|
|
7
|
+
|
|
8
|
+
```json
|
|
9
|
+
{
|
|
10
|
+
"source_path": "relative/path/within/corpus.md",
|
|
11
|
+
"source_location": "relative/path/within/corpus.md#heading-slug",
|
|
12
|
+
"heading_path": "Human-readable heading text",
|
|
13
|
+
"evidence_type": "text | table | structured-data | code | image-caption",
|
|
14
|
+
"level": 2,
|
|
15
|
+
"extracted_at": "ISO-8601 timestamp"
|
|
16
|
+
}
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## source_location conventions
|
|
20
|
+
|
|
21
|
+
| Source type | Convention | Example |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| Markdown/HTML heading | `path#heading-slug` | `handbook/lifecycle.md#archiving` |
|
|
24
|
+
| PDF page | `path#page-N` | `spec.pdf#page-12` |
|
|
25
|
+
| PPTX/Keynote-exported slide | `path#slide-N` | `deck.pptx#slide-7` |
|
|
26
|
+
| CSV/table row | `path#row-N` | `data.csv#row-42` |
|
|
27
|
+
| Source code | `path#Lstart-Lend` | `src/billing.ts#L120-L135` |
|
|
28
|
+
|
|
29
|
+
## Confidence labels
|
|
30
|
+
|
|
31
|
+
See `skills/project-knowledge-assistant/references/confidence-levels.md`:
|
|
32
|
+
`documented`, `verified-in-code`, `inferred`, `unverified-claim`, `superseded`.
|
|
33
|
+
|
|
34
|
+
## Non-negotiable rules
|
|
35
|
+
|
|
36
|
+
- Never fabricate a `source_location`.
|
|
37
|
+
- Never upgrade an inference to `documented`.
|
|
38
|
+
- Always preserve both sides of a contradiction rather than silently picking a winner.
|
|
39
|
+
- Treat superseded information as historically relevant, not simply deleted — keep the citation and
|
|
40
|
+
mark it superseded.
|