add examples
This commit is contained in:
parent
b8b04d7ca2
commit
2c74317780
5 changed files with 298 additions and 6 deletions
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
name: pov-doc
|
||||
description: This skill should be used when the user asks to "write a POV doc," "create a proof of value document," "POV criteria," "proof of concept criteria," "generate a POC document," or discusses creating a proof-of-value or proof-of-concept document for a Verkada customer evaluation. Generates a customer-facing POC/POV criteria document for Verkada physical security product evaluations.
|
||||
version: 1.0.0
|
||||
version: 1.1.0
|
||||
---
|
||||
|
||||
# POV Doc
|
||||
|
|
@ -23,13 +23,50 @@ Before generating the document, gather the following from the user's notes and c
|
|||
|
||||
Search `~/notes` for account notes, meeting notes, and inbox items related to the customer to populate these fields. Use ripgrep to find relevant content across all note files.
|
||||
|
||||
### Logo and Mission Statement
|
||||
|
||||
In addition to the fields above, gather these for the document header:
|
||||
|
||||
**Customer logo:** Search the web for the customer's official logo. Prefer high-resolution PNG files (at least 1000px wide). Good sources include the customer's website, Wikipedia/Wikimedia Commons, and official brand asset portals. Download the logo to a temporary location (e.g., `/tmp/`). If no high-res version is available, download what you can find and upscale it 4x using Pillow.
|
||||
|
||||
**Customer mission statement:** Search the web for the customer's official mission statement. Prefer the most recent version from their website or official publications (district improvement plans, annual reports, etc.). If the customer has both a mission and vision statement, use the mission statement.
|
||||
|
||||
Leave both as placeholders in the markdown (`<!-- Image goes here: ... -->` and `*"..."*`). The rendering step below will inject them into the final document.
|
||||
|
||||
## Document Generation and Rendering
|
||||
|
||||
### Step 1: Generate Markdown
|
||||
|
||||
Follow the Document Structure section below to write the markdown document.
|
||||
|
||||
### Step 2: Render to .odt
|
||||
|
||||
After generating the markdown, render it to a formatted .odt file using the bundled `scripts/render_poc.py` script:
|
||||
|
||||
```bash
|
||||
python3 skills/pov-doc/scripts/render_poc.py \
|
||||
--input "path/to/[Customer Name] POC Criteria.md" \
|
||||
--customer-logo /tmp/customer-logo.png \
|
||||
--mission "Customer mission statement here" \
|
||||
--output "path/to/[Customer Name] POC Criteria.odt"
|
||||
```
|
||||
|
||||
The script does the following:
|
||||
1. Replaces logo HTML comments with the actual customer logo and Verkada logo images
|
||||
2. Updates the mission statement if `--mission` is provided
|
||||
3. Converts the markdown to .odt using pandoc with the clean reference template (`examples/POC Reference Template.odt`)
|
||||
|
||||
The reference template carries over professional formatting (fonts, heading sizes, table styles, page margins) from the City of El Paso example without any customer-specific content.
|
||||
|
||||
Dependencies: `pandoc` (on PATH), `Pillow` (for logo resizing).
|
||||
|
||||
## Document Structure
|
||||
|
||||
The output document must follow this structure. Each section is required unless the user explicitly says it does not apply.
|
||||
|
||||
### Header
|
||||
- Document title: `# **Verkada Proof of Concept Criteria**`
|
||||
- Customer logo placeholder: `<!-- Image goes here: customer logo -->`
|
||||
- Customer logo placeholder: `<!-- Image goes here: [Customer Name] logo -->`
|
||||
- Verkada logo placeholder: `<!-- Image goes here: Verkada logo -->`
|
||||
- Customer mission statement (if known), formatted as a blockquote: `*"MISSION STATEMENT HERE"*`
|
||||
- Table of contents with anchor links to each numbered section
|
||||
|
|
@ -96,12 +133,15 @@ Numbered list of concrete next actions. Include any steps that have already been
|
|||
|
||||
## Examples
|
||||
|
||||
Two example documents are provided in the `examples/` folder:
|
||||
Example documents are provided in the `examples/` folder:
|
||||
- `examples/City of El Paso POC Criteria.md` - A completed POV document for a municipal access control evaluation
|
||||
- `examples/Proof of Concept Criteria - TEMPLATE.md` - A template-style POV document for a retail environment
|
||||
- `examples/POC Reference Template.odt` - Clean ODT reference template for pandoc rendering (styles only, no customer content)
|
||||
|
||||
Review these examples to match tone, structure, and formatting conventions. The El Paso example shows how to write a finalized document with specific details filled in. The template example shows the structure with placeholder content for a broader product evaluation.
|
||||
Review the markdown examples to match tone, structure, and formatting conventions. The El Paso example shows how to write a finalized document with specific details filled in. The template example shows the structure with placeholder content for a broader product evaluation.
|
||||
|
||||
## Output Location
|
||||
## Output
|
||||
|
||||
Write the generated document to `~/notes/Inbox/` with the filename format `[Customer Name] POC Criteria.md`.
|
||||
Write the generated markdown document to `~/notes/Inbox/` with the filename format `[Customer Name] POC Criteria.md`.
|
||||
|
||||
After rendering, the .odt file should be placed alongside the markdown or in the same location the user specifies.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue