All products

Check project documentation with AI

Compare commands, versions and paths in existing documentation with the repository, and distinguish stale facts from questions only the project owner can settle.

Check project documentation with AI when a new teammate follows the setup guide and discovers that the named test command no longer exists. The syncdocs skill asks the agent to verify each factual claim against the current checkout. A package script can establish the supported command, while a directory listing can confirm that a referenced path moved.

The task can end with a report. That is helpful when the team wants to see the discrepancies before deciding what to edit. Where the code cannot settle a statement about product intent, the reviewer can leave it as a question instead of silently rewriting the author’s explanation.

What it does

  • Check a documented dependency version against its manifest or lockfile.
  • Identify a command that has been renamed or removed.
  • Trace a file path in an existing guide to its present location.
  • Keep an unsupported claim separate from a confirmed discrepancy.
  • Make a targeted factual correction while preserving the author’s voice and section order.

Install and use

  1. Provide an authorised repository and its existing documentation. Request check mode for a read-only report; the normal sync workflow can commit documentation edits locally.
  2. Ask, “Check the onboarding guide against this checkout and report the evidence for each stale command. Make no edits yet.”
  3. Review the unresolved statements with the team before authorising a fix or commit.

FAQ

Source

Made by Timerise. Original skill: syncdocs, published on GitHub under the MIT licence.

View on GitHub