Skip to content

docs: strengthen Deckuse automation value #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AuntXue wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: strengthen Deckuse automation value #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@

</div>

Deckuse is a local-first, schema-driven Office document automation engine for coding agents. It opens a document into a versioned workspace, lets an agent inspect and target its structure, applies explicit JSON commands, validates the result, and exports a new document.
Deckuse is a local-first, schema-driven Office document automation engine for coding agents. It turns document editing into an explicit, reviewable workflow: open a versioned workspace, inspect and target its structure, apply JSON commands, validate the result, and export a new document.

PPTX is the currently implemented format. DOCX, XLSX, Keynote, and Numbers adapters deliberately return `FORMAT_NOT_IMPLEMENTED`; they are not supported editing targets yet.
The engine is built around format adapters. PPTX is the currently implemented format; DOCX, XLSX, Keynote, and Numbers adapters return `FORMAT_NOT_IMPLEMENTED` today, so agents fail clearly instead of silently producing unsafe edits.

## Why Deckuse

Expand All @@ -25,6 +25,20 @@ existing.pptx → init → inspect / query → apply JSON commands → validate

It preserves untouched XML and unknown package parts where possible. It is not a rendering engine and cannot reliably judge whether a slide is visually attractive or whether a layout is visually correct.

## Where it creates value

Deckuse is designed for document changes that need to be precise, repeatable,
and auditable:

- **Recurring content updates** — refresh dates, metrics, names, pricing, and
disclaimers without rebuilding a presentation.
- **Customer and market variants** — create controlled versions with explicit
selectors and reviewable operations.
- **Content governance** — query sensitive or outdated content, inspect every
match, and validate before export.
- **Agent-driven automation** — use structured JSON, revision checks, dry runs,
atomic batches, and operation logs in larger workflows.

## Installation

Requirements: Node.js 18 or later.
Expand Down