Chukke documentation

Model-ready

Use Chukke’s deterministic local analysis to review and prepare prompts and documentation.

Model-ready is Chukke’s local preparation workflow. It uses deterministic checks and does not call a model provider or send the document to one.

What the score means

Model-ready provides an advisory score from 0 to 100 across structure, clarity, completeness, and efficiency. Findings can cover Markdown cleanup, headings and lists, US and UK spelling, readability, placeholders, duplicate content, and token budgets.

Model-ready retains at most 10,000 findings in one analysis, with room reserved for structure, clarity, completeness, and efficiency so one noisy dimension cannot crowd out the others. The overview renders up to 100 findings at once, while focused review keeps a one-issue flow. To keep spelling review responsive, Model-ready checks words up to 32 characters and offers corrections for the first four distinct misspellings; later misspellings can still appear without alternatives. When checks or findings are omitted, one Analysis limited notice names the affected dimension and marks that dimension’s score provisional. Shorten unusual words, make some fixes, or shorten the document, then refresh to check the rest. This does not change the 10 MiB document open and edit limit.

The readiness band also protects against a strong average hiding a weak dimension. Ready requires an overall score of at least 85, no error findings, and at least 70 in every dimension. Not ready means the overall score is below 60 or a dimension is below 40. Other results show Needs review. The displayed score is rounded only after the band is determined.

For documents classified as prompts, additional checks cover the goal, constraints, expected output, validation, contradictions, and JSON contracts. These checks recognize equivalent section names and explicit inline instructions, so a concise prompt does not need headings named exactly Goal, Constraints, Output, and Validation. If an aspect is missing, Model-ready provides examples instead of inserting an empty section.

The score does not measure factual correctness and never blocks Apply, Copy, or optional provider assistance.

Prompt or documentation

Chukke classifies the active file locally. Explicit frontmatter is checked first, followed by known documentation filenames, prompt-directory paths, and strong content signals. Uncertain files default to Documentation.

Use frontmatter to override the local classification:

---
type: prompt
---

Use type: documentation for an explicit documentation override.

Review a document

  1. Open Model-ready for the active document.
  2. Review the score, detected type, dimensions, and findings.
  3. Inspect the eligible deterministic edits selected by default. Spelling is selected automatically only for a one-off, lowercase, single-edit correction with one clear dictionary suggestion. Proper nouns, repeated terms, compounds, and uncertain suggestions remain unselected. Semantic additions and rewrites require an explicit choice.
  4. Compare the line-numbered Source and Prepared views, or use Diff to isolate selected changes.
  5. Choose Apply selected to place the prepared candidate into the open tab as an unsaved edit, or Copy prepared without changing the source.

The source file does not change until you apply and then save the edit.

The second score is labelled Estimated. It updates immediately for selected edits and recalculates cleanup and token-budget effects without running the complete spelling and clarity analysis after every checkbox change. Applying the candidate or explicitly refreshing Model-ready runs the complete local analysis.

When the document changes

Normal editing marks the current analysis as out of date. Refresh Model-ready before applying, copying, or passing the prepared candidate to optional provider assistance.

Optional intent improvement

The Improve intent action appears only when Assist is enabled. It is a separate model-provider request and shows its full system instructions and user prompt for confirmation before the usual diff review.