Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.doc-reviewer.site/llms.txt

Use this file to discover all available pages before exploring further.

A project is the top-level container in Doc Reviewer. You create one project per product, add all the documents that belong to that product, and optionally generate a product context — a short description of the product that the LLM reads before evaluating any instruction. Working within projects keeps your documents organized and makes evaluation results more accurate and consistent across your team.

​
What a project contains

Each project stores:
  • A name that identifies the product (for example, “Firewall Manager” or “Identity Console”)
  • An optional product context — a ~400–700 word description generated by the LLM or written manually
  • All the documents assigned to that project
You can have as many projects as you have products. Documents belong to exactly one project at a time, and you can reassign them at any point.

​
The hierarchy: project → documents → instructions → evaluations

Everything in Doc Reviewer flows through this hierarchy:

Project

Groups documents for one product. Stores the product context used during evaluation.

Documents

Files or web pages loaded into the project. Each document is parsed into sections.

Instructions

Sections automatically identified as instructions. These are the units sent to the LLM.

Evaluations

Per-instruction results: a color, per-criterion pass/fail, and recommendations.
When you run an evaluation, Doc Reviewer evaluates each instruction inside each document. Instructions from different documents within the same project all receive the same product context, so the LLM has consistent background information throughout.

​
Product context

The product context is a plain-text description — roughly 400 to 700 words — that describes the product being documented. It is included in the LLM prompt for every instruction evaluation in the project, giving the model the background it needs to understand domain-specific terms, user roles, and component names. A typical product context covers:
  • The product’s name and category (for example, “network security appliance”, “identity management platform”)
  • The intended audience and their roles
  • 10–15 key terms and what they mean in this product’s context
  • Major components or subsystems the documentation refers to

​
Generating context automatically

Doc Reviewer can generate the product context for you by reading the non-instruction sections from your project’s documents — introductory text, glossary sections, overview pages, and similar reference material. To generate it:
1

Add documents to the project

Upload at least one document that contains introductory or reference sections. The generator reads up to 60 non-instruction sections across all documents in the project.
2

Open the project page

Go to Projects, click the project, and locate the Product context field.
3

Generate

Click Generate context. Doc Reviewer sends the non-instruction sections to the LLM and saves the result automatically.

​
Editing context manually

You can write or edit the product context at any time by clicking directly in the Product context field on the project page. Manual edits are saved without updating the generation timestamp, so you can refine the generated text without losing track of when it was last generated.
Generate the product context before you run your first evaluation. Without it, the LLM must rely solely on the instruction text and general knowledge of your domain, which reduces accuracy — especially for product-specific terminology.

​
Creating and managing projects

To create a project, go to Projects and click New project. Give the project a name that clearly identifies the product — you will see this name throughout the interface, including in the document header on the evaluation screen. To rename a project or update its context, open the project page and edit the fields directly.
Deleting a project does not delete the documents inside it. The documents remain in the system without a project assignment and can be reassigned to another project later.