docs: update README to v1.0.0
This commit is contained in:
@@ -1,3 +1,144 @@
|
|||||||
# mpm-sow-drafter
|
# mpm-sow-drafter
|
||||||
|
|
||||||
CoWork skill that drafts MPM Statements of Work for digital signage projects (LCD Wayside, Mobile Bus Retrofit, Solar Wayside, LED Wayside). Parses Odoo pricing files, classifies project type, asks targeted clarifying questions, and generates a branded .docx SOW.
|
Draft Statements of Work for Message Point Media (MPM) digital signage projects — LCD Wayside, Mobile Bus Retrofit, Solar Wayside, LED Wayside, or combinations.
|
||||||
|
|
||||||
|
**Version:** 1.0.0
|
||||||
|
**Author:** Bryan
|
||||||
|
**Repo:** https://git.alwisp.com/jason/mpm-sow-drafter
|
||||||
|
**CoWork Project:** CW-011 — MPM SOW Drafter
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The MPM SOW Drafter is a CoWork skill that takes Odoo quotation/sales order PDFs and produces a branded, client-ready Statement of Work .docx. It models MPM's three-party project structure (MPM as implementer, reseller as commercial customer, transit agency as end-client) and correctly splits responsibilities across all three. The skill parses product code patterns to classify project type, asks targeted clarifying questions about connectivity, training, pilot inclusion, and site survey scope, then generates a SOW using MPM's CEO-draft template with conditional sections based on what's actually in the quote. Payment milestones follow MPM's current 4-milestone structure.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Skills
|
||||||
|
|
||||||
|
| Skill | What It Does |
|
||||||
|
|---|---|
|
||||||
|
| `mpm-sow-drafter` | Parses MPM Odoo quotation/sales order PDFs (S00### format), classifies project type (LCD Wayside, Mobile Bus Retrofit, Solar Wayside, LED Wayside, or combination), runs a mandatory clarifying-questions phase, and produces a branded .docx SOW. Trigger phrases: "SOW", "statement of work", "scope of work", "draft a scope", "write up the project for [agency]", "turn this quote into an SOW", "scope document for this deployment", "SOW for the Vontas/Avail/TripSpark/IDIS project", uploading any Odoo S00### PDF. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workflow
|
||||||
|
|
||||||
|
### Phase 1 — Parse pricing files
|
||||||
|
Reads MPM Odoo quotation/sales order PDFs. Extracts line items grouped by category. Identifies reseller (invoicing address) and end-client agency (shipping address). Performs a sanity check for common contradictions (onsite hours without travel, displays without licensing, etc.).
|
||||||
|
|
||||||
|
### Phase 2 — Classify project type
|
||||||
|
Uses display SKU prefixes:
|
||||||
|
- `DSP-EX…` → LCD Wayside
|
||||||
|
- `DSP-LX…` → LED Wayside
|
||||||
|
- `DSP-M…` + mobile mount kit + DC power cable → Mobile Bus Retrofit
|
||||||
|
- Solar panel + battery + off-grid controller → Solar Wayside
|
||||||
|
|
||||||
|
Confirms classification with user before proceeding.
|
||||||
|
|
||||||
|
### Phase 3 — Clarifying questions (mandatory, never skipped)
|
||||||
|
|
||||||
|
Always asks: site survey inclusion, training delivery format, training audience tracks.
|
||||||
|
|
||||||
|
Conditionally asks:
|
||||||
|
- Pilot installation (for 10+ unit projects)
|
||||||
|
- Connectivity method and data plan ownership (critical for cellular — #1 source of disputes)
|
||||||
|
- Bus fleet details, models, and staging situation (mobile)
|
||||||
|
- Mounting engineering needs (wayside with MNT-E-MountingBudget)
|
||||||
|
- Permitting responsibility (wayside)
|
||||||
|
- Middleware needs (if TransitPoint not on quote)
|
||||||
|
- API integration specifics (if PS-Dev-T1 on quote)
|
||||||
|
|
||||||
|
### Phase 4 — Generate SOW .docx
|
||||||
|
Copies `assets/sow_template.docx` and edits in place. Strips working-note header. Fills in: Executive Summary, Hardware & Services Inventory Table, Project-Specific Assumptions, Exclusions, Responsibility Matrix (RACI), and Documentation Deliverables. Replaces payment milestones section with MPM's current 4-milestone structure. Conditionally includes/excludes sections per `references/section_map.md`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Payment Milestones (MPM Standard — replaces template language)
|
||||||
|
|
||||||
|
| Milestone | Trigger | Payment |
|
||||||
|
|---|---|---|
|
||||||
|
| Production Deposit | Contract execution, prior to production | 25% of Hardware + Warranty |
|
||||||
|
| Equipment Delivery | Delivery to client site or MPM staging | 75% of Hardware + Warranty |
|
||||||
|
| Go-Live | Licenses activated and assigned to production displays | 100% of Recurring Licenses |
|
||||||
|
| System Acceptance | Burn-in complete; SAT passed or Support transition | 100% of Professional Services |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Tools Reference
|
||||||
|
|
||||||
|
This is a skill-only plugin — no MCP server. Document generation uses the `docx` dependency skill.
|
||||||
|
|
||||||
|
| Dependency | Purpose |
|
||||||
|
|---|---|
|
||||||
|
| `docx` skill | Produces the final .docx Statement of Work |
|
||||||
|
|
||||||
|
### Files Included
|
||||||
|
|
||||||
|
| File | Purpose |
|
||||||
|
|---|---|
|
||||||
|
| `mpm-sow-drafter/SKILL.md` | Main skill instructions |
|
||||||
|
| `mpm-sow-drafter/references/section_map.md` | Template section keep/drop/modify decisions per project type |
|
||||||
|
| `mpm-sow-drafter/references/section_content.md` | Boilerplate language and fill-in patterns for generated sections |
|
||||||
|
| `mpm-sow-drafter/references/raci_patterns.md` | Standard RACI splits: MPM / Reseller / End-Client |
|
||||||
|
| `mpm-sow-drafter/references/product_codes.md` | Extended product code reference with SOW-implication notes |
|
||||||
|
| `mpm-sow-drafter/assets/sow_template.docx` | Bryan Gilliom CEO-draft template (starting point for every SOW) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Setup Instructions
|
||||||
|
|
||||||
|
1. Install the `mpm-sow-drafter` skill in CoWork (the `.skill` package includes all reference files and the SOW template)
|
||||||
|
2. Ensure the `docx` skill is also installed — mpm-sow-drafter reads its SKILL.md at runtime
|
||||||
|
3. No credentials, API keys, or additional configuration required
|
||||||
|
|
||||||
|
### Setup Checklist
|
||||||
|
- [ ] mpm-sow-drafter skill installed
|
||||||
|
- [ ] docx skill installed
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Supported Project Types
|
||||||
|
|
||||||
|
| Type | Key SKUs | Notes |
|
||||||
|
|---|---|---|
|
||||||
|
| LCD Wayside | `DSP-EX…`, `EX49KV`, `EX55KVD` | Fixed outdoor kiosks and displays; site surveys typical |
|
||||||
|
| LED Wayside | `DSP-LX…` | Modular LED pendant/panel displays; often paired with ADA switchboxes |
|
||||||
|
| Mobile Bus Retrofit | `DSP-M…` + `KIT-MNT-M-…` + `CBL-DC-…` | Vehicle-rated displays; bus-model-specific mounting kits |
|
||||||
|
| Solar Wayside | Solar panel + battery + off-grid controller | Off-grid power; most restrictive engineering callouts |
|
||||||
|
| Combined | Mix of above SKUs | Executive Summary explicitly names both sub-scopes |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Exclusions (always in generated SOW)
|
||||||
|
|
||||||
|
- Permitting, inspections, and municipal approval fees
|
||||||
|
- Professional structural/civil engineering
|
||||||
|
- ADA compliance certification (MPM provides guidance only)
|
||||||
|
- Network infrastructure beyond final drop at display location
|
||||||
|
- Cellular data plans (unless explicitly included per Phase 3 answer)
|
||||||
|
- Middleware not listed in Appendix A
|
||||||
|
- Day-to-day content creation and ongoing editorial work
|
||||||
|
- Post-Go-Live support, maintenance, and retraining (requires separate S&M Agreement)
|
||||||
|
- Removal/disposal of existing equipment (unless itemized)
|
||||||
|
- Any hardware, software, or service not itemized in the referenced quotation(s)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- CoWork (Cowork mode in Claude desktop app)
|
||||||
|
- `docx` skill
|
||||||
|
- MPM Odoo quotation or sales order PDF(s) (S00### format)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
| Symptom | Fix |
|
||||||
|
|---|---|
|
||||||
|
| Wrong project classification | Skill classifies by display SKU prefix — verify SKUs in the quote match expected pattern |
|
||||||
|
| Responsibility Matrix incomplete | All Phase 3 questions must be answered; cellular data plan ownership is the most commonly skipped |
|
||||||
|
| Payment milestones show old template language | The skill always replaces template milestones — if old language appears, the unpack/repack likely failed |
|
||||||
|
| Missing reference files at runtime | Ensure the full `.skill` package was installed, not SKILL.md alone |
|
||||||
|
|||||||
Reference in New Issue
Block a user