Documentation Review Skill for ChatGPT: Reconcile CLI Flags, Interface Signatures and Examples
Compare README, interface documentation, and changelog excerpts with supplied implementation or help output. Attach evidence and a verifiable edit to each mismatch.
中文Install in ChatGPT
Requires a ChatGPT workspace where you can create skills. This is a text adaptation of the pinned GitHub source.
- Review the inputs and outputs in the pinned .claude/skills/documentation-review/SKILL.md.
- In ChatGPT, open Plugins, Skills, Create, and Create with editor.
- Write the skill rules using the workflow described here. Provide interface or CLI output, document excerpts, and version information.
- Save the skill and check the fictional example in a new chat.
Example task
A fictional preset tool README uses `--count`, while current help lists only `--amount`. The example omits its version. Produce a check table and suggested edit.What to check
Record both text locations and their versions. Update the example to `--amount` once the intended release is confirmed, then label the applicable version.
Original SKILL.md on GitHub · Updated
Frequently asked question
What if the development branch and release differ?
Preserve evidence for both versions. Identify the documentation branch or release being maintained before editing the relevant example.