Check against docs
Compare a ticket's story with your team's reference docs and see, with quotes, where they agree and where they disagree.
Check against docs reads a ticket’s story and criteria against the workspace’s docs library: your specifications, design notes, policies and wiki pages. It tells you where the ticket matches what the docs say, where it goes against them, and what to do about it. Every point quotes the passage it rests on.
#What you need
- At least one built document in the workspace’s library.
- AI set up in Settings → AI.
This check does not need Use reference docs in AI Review to be on. That setting is about reviews; pressing the button is enough here.
#Run the check
- Open the ticket’s story view.
- Press Check against docs in the Ticket section’s heading. The button reads Checking… while it runs, with “Choosing sections…” and then “Reading the docs…” under a progress bar.
- Read the result in the Docs check block. To run it again, press Check docs again.
#What you see
The ticket allows refunds for 60 days. The refund policy allows 30 days, and the finance handbook relies on that limit.
What to do
Check docs again
- A verdict: Matches the docs, Partly matches the docs or Goes against the docs.
- A summary of two or three sentences.
- What to do: a few concrete steps.
- A note under each criterion the docs bear on, marked Matches, Partly or Differs.
- Other parts of the ticket: points about the story that are not one criterion.
Select a reference to open the section in Docs, scrolled to the quoted passage and highlighted. When nothing in the library bears on the ticket, the block says so in one line.
#How it decides
- It checks the criteria from the latest story check, else the ticket’s own, else a list AI works out from the description (and says so).
- With a small library, AI reads all of it. With a large one, Limn first finds the sections that share words with the ticket, AI picks up to eight of them, and then reads only those.
- Every point must quote a section of your library, and Limn checks that the quote is really there. A point with no checked quote is dropped, never shown. So the check can say less than AI wrote, but never something your docs do not say.
#When nothing has changed
If the story, the criteria and the library are the same as at the last check, pressing the button again gives the same result at no cost, with “Nothing has changed since this check.” Press Check again anyway to run it fresh. When the ticket or the library changes, the result is marked Out of date.