Skip to content
Back to search

qrg-builder

OS- and app-agnostic Quick Reference Guide (QRG) Builder skill and kit

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/cmiano1--qrg-builder/badge.svg)](/listings/cmiano1--qrg-builder)

HTML

<a href="/listings/cmiano1--qrg-builder"><img src="/api/listings/cmiano1--qrg-builder/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Requirements

- **Node.js 22+ (LTS)** - **LibreOffice** (free; portable/no-admin options work on Windows, macOS, and Linux)

1. Get the Skill

Clone this repository (or download it as a ZIP from GitHub) and place the `qrg-builder/` folder where your AI tool loads skills:

| Scope | Where to put `qrg-builder/` | |---|---| | **Single project only** *(Antigravity / Codex / Cursor)* | `<your-project>/.agents/skills/qrg-builder/` | | **All projects (Global — Antigravity)** | `~/.gemini/config/skills/qrg-builder/` | | **All projects (Global — Claude Code)** | `~/.claude/skills/qrg-builder/` |

2. Install Kit Dependencies & Run Health Check

From inside `qrg-builder/kit/`:

npm install
npm run check

You should see `RESULT: kit ready`.

For complete step-by-step instructions (including no-admin LibreOffice setup and optional video frame extraction), see **[Setup for Teammates](qrg-builder/references/setup_for_teammates.md)**.

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 52 lines
  1. # QRG Builder
  2. An OS- and app-agnostic AI skill and Node.js toolkit for building, reviewing, and releasing **Quick Reference Guides (QRGs)** as Standard US Letter Word (`.docx`) documents from recordings, screenshots, and notes.
  3. Works on **Windows, macOS, and Linux** in **Antigravity, Claude Code, Codex, Cursor**, or as a standalone Node.js CLI—with **no paid Microsoft Office or admin-install requirements**.
  4. ---
  5. ## What It Does
  6. - **Single source of truth:** Authors guides in structured JavaScript (`guides/NN.js`) and builds clean, Google Docs–compatible `.docx` files.
  7. - **Screenshot annotation:** Adds numbered callouts, highlights, and crops from source captures (`annotate_screenshot.js`).
  8. - **Automated QA & offline proofing:** Checks formatting, banned words, names, and spelling/grammar offline (`qa_qrgs.js` + `proof_guides.js` via `harper.js`).
  9. - **Visual page renders:** Converts every build to PDF and page PNGs using headless LibreOffice so every page can be visually inspected.
  10. - **Built-in review & release locks:** Review guides in a local **Browser Review UI** (`127.0.0.1`) or an `.xlsx` **OK List**, protected by SHA-256 Review Locks so only exact approved builds become final Send Copies.
  11. ---
  12. ## Quick Setup
  13. ### Requirements
  14. - **Node.js 22+ (LTS)**
  15. - **LibreOffice** (free; portable/no-admin options work on Windows, macOS, and Linux)
  16. ### 1. Get the Skill
  17. Clone this repository (or download it as a ZIP from GitHub) and place the `qrg-builder/` folder where your AI tool loads skills:
  18. | Scope | Where to put `qrg-builder/` |
  19. |---|---|
  20. | **Single project only** *(Antigravity / Codex / Cursor)* | `<your-project>/.agents/skills/qrg-builder/` |
  21. | **All projects (Global — Antigravity)** | `~/.gemini/config/skills/qrg-builder/` |
  22. | **All projects (Global — Claude Code)** | `~/.claude/skills/qrg-builder/` |
  23. ### 2. Install Kit Dependencies & Run Health Check
  24. From inside `qrg-builder/kit/`:
  25. ```sh
  26. npm install
  27. npm run check
  28. ```
  29. You should see `RESULT: kit ready`.
  30. For complete step-by-step instructions (including no-admin LibreOffice setup and optional video frame extraction), see **[Setup for Teammates](qrg-builder/references/setup_for_teammates.md)**.
  31. ---
  32. ## Repository Contents
  33. - [`qrg-builder/SKILL.md`](qrg-builder/SKILL.md) — Main skill instructions and end-to-end workflow
  34. - [`qrg-builder/kit/`](qrg-builder/kit/) — Build, QA, proofing, annotation, rendering, and Browser Review UI scripts
  35. - [`qrg-builder/references/`](qrg-builder/references/) — Content rules, screenshot rules, Definition of Done, and teammate setup guide

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.