# Doc Reviewer

## Docs

- [Criteria: the quality rules for evaluating instructions](https://www.doc-reviewer.site/en/concepts/criteria.md): Criteria are Markdown rules the LLM uses as a rubric for each instruction. Doc Reviewer ships with a built-in set covering structure, steps, and completeness.
- [Documents: how Doc Reviewer parses and classifies content](https://www.doc-reviewer.site/en/concepts/documents.md): Upload files or load URLs into a project. Doc Reviewer parses documents into sections and classifies each as instruction, possible, or non-instruction content.
- [Evaluation: how Doc Reviewer scores each instruction](https://www.doc-reviewer.site/en/concepts/evaluation.md): Evaluation sends instructions to the LLM with criteria and context. Results arrive in real time: a color rating, per-criterion pass/fail, and recommendations.
- [Projects: group documents with shared product context](https://www.doc-reviewer.site/en/concepts/projects.md): A project groups all documents for a single product and stores a product context that helps the LLM evaluate your instructions more accurately.
- [Create and switch between evaluation criteria sets](https://www.doc-reviewer.site/en/configuration/criteria-sets.md): Create, edit, and switch between criteria sets to control how Doc Reviewer evaluates your instructions. Only the active criteria set is used during evaluation.
- [Write your own evaluation criteria in Doc Reviewer](https://www.doc-reviewer.site/en/configuration/custom-criteria.md): Author criteria sets in Markdown to match your documentation standards. Define groups, numbered criteria, optional checks, and the LLM evaluator role.
- [Connect an LLM model to run Doc Reviewer evaluations](https://www.doc-reviewer.site/en/configuration/llm-models.md): Configure OpenAI, Anthropic, Ollama, or any OpenAI-compatible model as the evaluation engine. All API keys are stored locally and never sent to Doc Reviewer.
- [Install Doc Reviewer on Windows and confirm it runs](https://www.doc-reviewer.site/en/installation.md): Download the Doc Reviewer executable and run it, or build from source. Covers system requirements, Chromium setup, and verifying the backend is running.
- [Doc Reviewer: evaluate instruction quality with AI](https://www.doc-reviewer.site/en/introduction.md): Doc Reviewer is a desktop app for technical writers that uses LLMs to automatically detect and evaluate the quality of instructions in your documentation.
- [Quickstart: run your first Doc Reviewer evaluation](https://www.doc-reviewer.site/en/quickstart.md): From a fresh install to your first LLM-powered evaluation in minutes. Connect a model, add a project, specify evaluation criteria, upload a document and review results.
- [Frequently asked questions about using Doc Reviewer](https://www.doc-reviewer.site/en/troubleshooting/faq.md): Answers to the most common questions about how Doc Reviewer works, what it sends to the cloud, which LLM models to use, and where your data is stored.
- [Doc Reviewer current limitations and known constraints](https://www.doc-reviewer.site/en/troubleshooting/known-limitations.md): Known constraints covering parsing, language support, single-user design, LLM dependency, web page loading, evaluation timeout, and permanent deletion behavior.
- [Load and evaluate your documentation web pages by URL](https://www.doc-reviewer.site/en/workflows/evaluate-web-page.md): Load one or more web pages by URL using a headless Chromium browser, then evaluate their instructions as a single document in Doc Reviewer.
- [Export your Doc Reviewer evaluation results to Excel](https://www.doc-reviewer.site/en/workflows/export.md): Download evaluation results as an XLS file with one row per instruction showing the section title, page number, color rating, and LLM recommendations.
- [Review evaluation results and manage false positives](https://www.doc-reviewer.site/en/workflows/review-results.md): Understand color-coded evaluation results, read per-criterion feedback, mark false positives to override the LLM, re-evaluate, and reset results when needed.
- [Save evaluation snapshots and compare quality over time](https://www.doc-reviewer.site/en/workflows/snapshots.md): Save evaluation results as a named snapshot, organize them in Product Groups, and compare two snapshots side by side to track documentation quality over time.
- [Upload a document and review detected instructions](https://www.doc-reviewer.site/en/workflows/upload-document.md): Upload a PDF, DOCX, Markdown, or TXT file to Doc Reviewer. The app automatically parses the document structure and classifies each section for evaluation.
- [Критерии: правила оценки качества инструкций](https://www.doc-reviewer.site/ru/concepts/criteria.md): Критерии — это правила в формате Markdown, которые LLM использует как рубрику для каждой инструкции. Doc Reviewer поставляется со встроенным набором, охватывающим структуру, шаги и полноту.
- [Документы: разбор и классификация контента](https://www.doc-reviewer.site/ru/concepts/documents.md): Загружайте файлы или URL в проект. Doc Reviewer разбирает документы на разделы и классифицирует каждый как инструкцию, возможную инструкцию или обычный контент.
- [Оценка: как Doc Reviewer анализирует каждую инструкцию](https://www.doc-reviewer.site/ru/concepts/evaluation.md): Оценка отправляет инструкции в LLM вместе с критериями и контекстом. Результаты поступают в режиме реального времени: цветовая оценка, результаты по критериям и рекомендации.
- [Проекты: группировка документов с общим контекстом продукта](https://www.doc-reviewer.site/ru/concepts/projects.md): Проект группирует все документы одного продукта и хранит контекст продукта, который помогает LLM точнее оценивать инструкции.
- [Создание наборов критериев и переключение между ними](https://www.doc-reviewer.site/ru/configuration/criteria-sets.md): Создавайте, редактируйте и переключайтесь между наборами критериев, чтобы управлять тем, как Doc Reviewer оценивает инструкции. Для оценки используется только активный набор.
- [Написание пользовательских критериев оценки](https://www.doc-reviewer.site/ru/configuration/custom-criteria.md): Создавайте наборы критериев в формате Markdown под стандарты вашей документации. Определяйте группы, нумерованные критерии, необязательные проверки и роль оценщика LLM.
- [Подключение LLM-модели для оценки в Doc Reviewer](https://www.doc-reviewer.site/ru/configuration/llm-models.md): Настройте OpenAI, Anthropic, Ollama или любую совместимую с OpenAI модель. Все API-ключи хранятся локально и не передаются в Doc Reviewer.
- [Установка Doc Reviewer на Windows](https://www.doc-reviewer.site/ru/installation.md): Установите из исполняемого файла или соберите из исходного кода.
- [Doc Reviewer: оценка качества инструкций с помощью ИИ](https://www.doc-reviewer.site/ru/introduction.md): Doc Reviewer — настольное приложение для технических писателей, которое использует LLMs для автоматического обнаружения и оценки качества инструкций в вашей документации.
- [Быстрый старт: первая оценка в Doc Reviewer](https://www.doc-reviewer.site/ru/quickstart.md): От чистой установки до первой оценки с помощью LLM за несколько минут. Подключите модель, добавьте проект, укажите критерии оценки, загрузите документ и просмотрите результаты.
- [Часто задаваемые вопросы об использовании Doc Reviewer](https://www.doc-reviewer.site/ru/troubleshooting/faq.md): Ответы на самые распространённые вопросы о том, как работает Doc Reviewer, что он отправляет в облако, какие LLM-модели использовать и где хранятся данные.
- [Известные ограничения Doc Reviewer](https://www.doc-reviewer.site/ru/troubleshooting/known-limitations.md): Задокументированные ограничения: разбор документов, поддержка языков, однопользовательский режим, зависимость от LLM, загрузка веб-страниц, таймаут оценки и необратимое удаление.
- [Загрузка и оценка веб-страниц документации по URL](https://www.doc-reviewer.site/ru/workflows/evaluate-web-page.md): Загружайте одну или несколько веб-страниц по URL через headless-браузер Chromium, затем оценивайте их инструкции как единый документ в Doc Reviewer.
- [Экспорт результатов оценки в Excel](https://www.doc-reviewer.site/ru/workflows/export.md): Скачайте результаты оценки в виде XLS-файла с одной строкой на инструкцию: заголовок раздела, номер страницы, цветовая оценка и рекомендации LLM.
- [Просмотр результатов оценки и управление ложными срабатываниями](https://www.doc-reviewer.site/ru/workflows/review-results.md): Разберитесь в цветовых результатах оценки, читайте обратную связь по критериям, отмечайте ложные срабатывания, повторно запускайте оценку и при необходимости сбрасывайте результаты.
- [Сохранение снимков оценки и сравнение качества со временем](https://www.doc-reviewer.site/ru/workflows/snapshots.md): Сохраняйте результаты оценки в виде именованного снимка, организуйте их в группы продуктов и сравнивайте два снимка рядом для отслеживания качества документации.
- [Загрузка документа и просмотр обнаруженных инструкций](https://www.doc-reviewer.site/ru/workflows/upload-document.md): Загрузите PDF, DOCX, Markdown или TXT в Doc Reviewer. Приложение автоматически разбирает структуру документа и классифицирует каждый раздел для оценки.

## OpenAPI Specs

- [openapi](https://www.doc-reviewer.site/api-reference/openapi.json)