sovel.pro Evidence-aware platform
Documentation & help

Documentation

Every SOVEL product ships with its own documentation. This page explains what that documentation covers, what is published here, and how to move between a product, its documentation and related research.

How to read this page

Three distinct states

Documentation exists in two different places, and it is worth being precise about which is which. Documentation that ships inside a product package is not the same as documentation published on this website.

AVAILABLE NOW

Ships with the product

Guides, reference material, workflows and prompts included inside each product package. These exist today and travel with the product.

PUBLIC SURFACE

Public product documentation

Detailed specifications, requirements, architecture, and FAQs published directly on each product page and indexed here.

IN PACKAGE

Changelogs & release notes

Version history, release notes, and audit checksums are maintained directly inside each verified product archive.

What this page will not do

This page does not list documentation that does not exist. Where something is planned rather than available, it is labelled as planned. Where a decision has not been made, it is labelled as not yet published rather than filled in.

Documentation by product

What each product ships with

Counts below describe what is actually inside each product package today.

SYSTEMSystems family

AI Engineering OS

The most heavily documented product in the set — a rulebook, a checklist library, a prompt library and worked examples.

Inside the package

  • Core rulebook — the master rulebook, agent guidance and the checklist library
  • 24-prompt library — covering new projects, existing codebases, WordPress plugins and themes, WooCommerce, AI agents, API integration, automation, refactoring, debugging, research, architecture, verification, documentation and maintenance
  • 15 workflow guides — including the full engineering lifecycle, idea-to-product, model handoff and multi-model review
  • 12 worked example projects — from a non-coder idea through to a WordPress theme
  • 7 platform guides — for the AI environments it can wrap
  • Mode guides — beginner, developer, build-from-scratch and existing-codebase
  • User guide, quick start, product overview and FAQ
Documentation availability

Comprehensive package documentation ships directly in the digital download archive (Markdown guides, checklists, platform references). The public product page provides the architectural overview.

Getting started: Quick Start guide & Mode Guides (Beginner / Developer) included in package archive.

Requirements: Markdown-capable editor or workspace; access to an AI assistant or coding agent of choice; platform-independent.

Available routes

Product page7-Stage lifecycle & workflowSupport route
ENGINEEngines family

Book Creation Engine

Documentation is organised per engine, matching the sixteen-stage pipeline, with a separate guide set for using the system.

Inside the package

  • Sixteen engine folders — one per pipeline stage, BCE-01 through BCE-16
  • Nine documentation guides — engine usage, project setup, prompt engineering, AI tool integration, feature reference, project template, best practices, FAQ and quick start
  • Architecture and dependency references — architecture overview, engine index, dependency graph and engine integration guide
  • Continuity references — the manuscript contract, novel bible and knowledge-memory engine
  • User manual, developer guide and example workflow
Documentation availability

Complete 16-stage pipeline documentation, user manual, and engine references ship inside the product ZIP archive. The public page details the full 16-engine architecture.

Getting started: Engine Quick Start guide & Project Setup templates included in package archive.

Requirements: Standard development or text editing environment; AI model access supporting multi-turn structured prompting.

Available routes

Product page16-Stage pipeline architectureSupport route
ENGINEResearch family

Content Gap Finding Engine

Documentation is split between the engine and the skill layer, matching the product’s architecture. Setup includes API credential configuration.

Inside the package

  • Engine documentation — how to use the engine, plus a dedicated API credential setup guide
  • Architecture documentation — the engine-versus-skill comparison explaining how the two layers divide responsibility
  • An indexed prompt library — each prompt defining its input, context, expected output, assumptions and evidence handling
  • Research and production guides — including a book research and production guide
  • Self-check tooling — a built-in diagnostic command and an automated test suite
  • Sample inputs — so a first run can be made without preparing data
Documentation availability

Engine operation guides, API credential configuration instructions, and evidence grading references ship directly inside the archive. The public page details the 9-step research discipline.

Getting started: Self-check diagnostic command, automated test suite, and sample inputs included in package archive.

Requirements: Python/CLI execution environment; search/LLM API credentials for live research data collection.

Available routes

Product page9-Step research workflowSupport route
TOOLFree Tools family

Document & Text Utilities

Browser-local utilities for document validation, inspection, and format verification.

Inside the package

  • Browser-local workflow tools — zero server round-trip document processing
  • Document validation and inspection utilities
  • Format verification and integrity checks
Documentation availability

Browser-local utilities with inline usage guidance. Zero server round-trip; runs entirely in modern web browsers.

Getting started: Immediate browser execution; zero installation or account required.

Requirements: Modern web browser supporting ES6+ JavaScript and local file APIs.

Available routes

Product pageOpen free toolsSupport route

What SOVEL documentation covers

Every product’s documentation is structured the same way, so you always know where to look — whether you are deciding, operating or maintaining.

Understanding

  • What the product is — and what it is not
  • The problem it solves and who it is for
  • How it works, stage by stage or engine by engine
  • The workflow it enforces

Operating

  • Setup and configuration, including credentials where required
  • Expected inputs and produced outputs
  • Requirements and compatibility
  • Limitations, stated plainly

Maintaining

  • Version and release discipline
  • Upgrade guidance
  • Support routes
  • Changelog — where a public release exists

Reference

  • Stage, engine and prompt references
  • Evidence classes and the rules that govern them
  • Terminology
  • Worked examples
Finding your way

Each step adds depth. You can stop at any point, and every page links back to the ones above it.

Free toolProductDocumentationResearch & guidesRelated products

1 · Try a free tool

Start with a bounded task. Free tools need no account for browser-local work.

2 · Read the product page

Each documented product page carries its own explanation, workflow and requirements. Start at the product library.

3 · Go deeper

Research explains the evidence discipline; related products are linked from the bottom of every product page.

Why product pages are the documentation surface today

A product page in SOVEL is designed to be both a sales page and a documentation page — it must explain the product, not merely describe it. Until standalone web documentation is published, the product page is where that explanation lives.

Documentation status

Honest status

The three documented products each ship with substantial documentation inside their packages, summarised above. Standalone web documentation, guides and public changelogs are not published yet. That is why this page describes what each package contains rather than linking to documentation pages that do not exist.

Browse productsGet support