docs: replace auto-init README with project README

2026-05-29 17:23:09 -05:00
parent 18b7697d5e
commit b9b509ec61
1 changed files with 60 additions and 2 deletions
@@ -1,3 +1,61 @@
-# mpm-part-number-manager
+# MPM Part Number Manager

-CoWork skill for creating and auditing MPM part numbers against the SKU schema. Architecture: SKILL.md + audit logic only; all taxonomy data referenced from Google Drive.
+**CW-018 | Status: Proposed | Priority: High**
+
+A CoWork skill that gives any Claude session the ability to create correctly formatted MPM part numbers from plain-language descriptions, and to audit existing part numbers against the v1.4 SKU schema.
+
+---
+
+## Architecture
+
+This skill follows **Option A — Reference, Do Not Embed.**
+
+All taxonomy data lives in the MPM Google Drive Shared Drive and is read at runtime. Nothing schema-specific is locked inside the skill files. This allows 10+ CoWork users to update taxonomy without requiring skill updates.
+
+### What Lives in This Repo
+
+| File | Purpose |
+|---|---|
+| `SKILL.md` | Entry points, logic, decision trees, Google Drive file paths |
+| `audit-rules.md` | Discrete validation rules — logic only, no taxonomy data |
+
+### What Lives in Google Drive (referenced at runtime)
+
+| File | Contents |
+|---|---|
+| `MPM_SKU_System_Reference.md` | Full v1.4 schema — authoritative |
+| `MPM_SKU_Sequence_Tracker.md` | Current pool state + assignment history |
+| `MPM_SKU_Decision_Log.md` | Dated taxonomy rulings *(to create)* |
+| `MPM_SKU_Undocumented_Subtypes.md` | Sub-types in use, not yet in schema *(to create)* |
+| `MPM_SKU_Skill_BuildBrief.md` | Full build brief with all context and open decisions |
+
+---
+
+## Entry Points
+
+**CREATE** — Plain-language description to correctly formatted part number, with sequence ID assignment.
+
+**AUDIT** — One or more existing part numbers validated against schema; every structural violation surfaced by issue type (excluding UniqueID values).
+
+---
+
+## Dependencies
+
+- Google Workspace MCP (reading Drive reference files)
+- Odoo MCP (product catalog integration)
+- Display Catalog Skill (MPTV-/MP- product numbers)
+
+---
+
+## Contributors
+
+Owner: Bryan Gilliom | Taxonomy Maintenance: Simeon, Tiffany
+
+---
+
+## Reference Files Location
+
+All taxonomy files live in:
+`Shared drives/DOCUMENTATION/Part - Model Number and Taxonomy Information/`
+
+See `references/MPM_SKU_Skill_BuildBrief.md` for complete build context, open decisions, and nuance checklist.