Agent skill

Docs Update from Diff

by QwenLM in QwenLM/qwen-code

Reads local git changes and updates only the matching docs pages, so documentation stays in sync with uncommitted or recent code changes.

Apache-2.0Auto-check passedDevelopment

Install Docs Update from Diff

skills CLI
$ npx skills add QwenLM/qwen-code --skill docs-update-from-diff -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install QwenLM/qwen-code docs-update-from-diff --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/QwenLM/qwen-code.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.qwen/skills/docs-update-from-diff .claude/skills/docs-update-from-diff && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-update-from-diff
GitHub stars
28k
Token cost
~1.1k tokens
SKILL.md length
540 words
Files
2 (incl. references)
Skills in repo
41
Repo updated
First seen
Licence
Apache-2.0

At a glance

Reads local git changes and updates only the matching docs pages, so documentation stays in sync with uncommitted or recent code changes.

  • Works in 5 steps: Build the change set → Derive the docs impact → Find the right docs location → …
  • Documenting uncommitted local changes before opening a pull request
  • SKILL.md covers Overview, Workflow, Practical heuristics and Deliverable
  • Calls git

What it does

The skill starts from `git status --short`, `git diff --stat` and targeted `git diff` output rather than assumptions, focusing on non-doc changes first so any documentation update is grounded in real code. For each changed behavior it extracts what documentation must now reflect: a new command, flag, config key, default or limitation, a rename or removal, changed examples or setup steps, or a feature that belongs on an existing page but is not mentioned yet.

Changes are mapped to the smallest correct docs surface, splitting end-user behavior under `docs/users/**` from developer internals under `docs/developers/**`, and a new page updates the nearest `_meta.ts` so it stays discoverable. Updates describe current behavior rather than implementation history, use concrete commands and paths taken from the diff, and remove stale text instead of layering warnings on it. A final pass searches for old names or removed flags and re-reads the changed docs against the code diff rather than memory. `references/docs-surface.md` helps when a change does not map cleanly to an existing section.

When your agent uses it

  • Documenting uncommitted local changes before opening a pull request
  • Syncing docs with a recent feature or refactor
  • Updating docs to match a git diff instead of writing from scratch

Example prompts

  • “Look at my git diff and update the docs to match these changes.”
  • “Sync docs/ with the refactor I just made to the config loader.”
  • “Update the official docs for the new --dry-run flag I added.”

Requirements

  • A Git repository with local changes to inspect

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. Build the change set
  2. Derive the docs impact
  3. Find the right docs location
  4. Write the update
  5. Cross-check before finishing

What it can do on your machine

Read from SKILL.md and the folder at commit 4970bfa. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Update from Diff loads about 1.1k tokens when it runs, and up to ~1.8k if it reads all its reference files. Until then it costs about 84 tokens; SKILL.md has 540 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~84
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~1.8k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from QwenLM/qwen-code at commit 4970bfa, republished under its Apache-2.0 licence (© QwenLM). 540 words, ~1,067 tokens.

Download SKILL.mdSave it as .claude/skills/docs-update-from-diff/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
docs-update-from-diff
description
Review local code changes with git diff and update the official docs under docs/ to match. Use when the user asks to document current uncommitted work, sync docs with local changes, update docs after a feature or refactor, or when phrases like "git diff", "local changes", "update docs", or "official docs" appear.

Docs Update From Diff

Overview

Inspect local diffs, derive the documentation impact, and update only the repository's docs/ pages. Treat the current code as the source of truth and keep changes scoped, specific, and navigable.

Read references/docs-surface.md before editing if the affected feature does not map cleanly to an existing docs section.

Workflow

1. Build the change set

Start from local Git state, not from assumptions.

  • Inspect git status --short, git diff --stat, and targeted git diff output.
  • Focus on non-doc changes first so the documentation delta is grounded in code.
  • Ignore README.md and other non-docs/ content unless they help confirm intent.
2. Derive the docs impact

For every changed behavior, extract the user-facing or developer-facing facts that documentation must reflect.

  • New command, flag, config key, default, workflow, or limitation
  • Renamed behavior or removed behavior
  • Changed examples, paths, or setup steps
  • New feature that belongs in an existing page but is not mentioned yet

Prefer updating an existing page over creating a new page. Create a new page only when the feature introduces a stable topic that would make an existing page harder to follow.

3. Find the right docs location

Map each change to the smallest correct documentation surface:

  • End-user behavior: docs/users/**
  • Developer internals, SDKs, contributor workflow, tooling: docs/developers/**
  • Shared landing or navigation changes: root docs/** and _meta.ts

If you add a new page, update the nearest _meta.ts in the same docs section so the page is discoverable.

4. Write the update

Edit documentation with the following bar:

  • State the current behavior, not the implementation history
  • Use concrete commands, file paths, setting keys, and defaults from the diff
  • Remove or rewrite stale text instead of stacking caveats on top of it
  • Keep examples aligned with the current CLI and repository layout
  • Preserve the repository's existing docs tone and heading structure
Show full SKILL.md (239 more words)Show less
5. Cross-check before finishing

Verify that the updated docs cover the actual delta:

  • Search docs/ for old names, removed flags, or outdated examples
  • Confirm links and relative paths still make sense
  • Confirm any new page is included in the relevant _meta.ts
  • Re-read the changed docs against the code diff, not against memory
  • If the diff added, moved, renamed, or removed a page under docs/users/, verify the qc-helper bundled skill's topic-to-path index tables (packages/core/src/skills/bundled/qc-helper/SKILL.md) are updated to match. This skill ships with the CLI and uses hardcoded doc-path tables at runtime — stale entries cause /qc-helper to miss the right documentation. Also check project-level skills under .qwen/skills/ for hardcoded docs/users/ references that may need updating.

Practical heuristics

  • If a change affects commands, also check quickstart, workflows, and feature pages for drift.
  • If a change affects configuration, also check docs/users/configuration/settings.md, feature pages, and auth/provider docs.
  • If a change affects tools or agent behavior, check both docs/users/features/** and docs/developers/tools/** when relevant.
  • If tests reveal expected behavior more clearly than implementation code, use tests to confirm wording.
  • If the change adds, moves, renames, or removes a docs page, also update hardcoded doc-path consumers: qc-helper's SKILL.md index tables, _meta.ts navigation files, and any project-level skills under .qwen/skills/ that reference docs/users/ paths.

Deliverable

Produce the docs edits under docs/ that make the current local changes understandable to a reader who has not seen the diff. Keep the final summary short and identify which pages were updated.

© QwenLM, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (references) in .qwen/skills/docs-update-from-diff of QwenLM/qwen-code.

  • SKILL.md
  • references/docs-surface.md

Open the folder on GitHubat commit 4970bfa

Compare with similar skills

Docs Update from Diff next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Update from Diff compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Update from Diff this skillQwenLM/qwen-code28k—~1.1kAutomated safety check: PassApache-2.0
Update DocsArcReel/ArcReel5.3k—~544Automated safety check: NotesAGPL-3.0
Merge Masterkeybase/client9.3k—~1.3kAutomated safety check: PassBSD-3-Clause
Facade YARD Documentation Rulesruby-git/ruby-git1.8k—~5kAutomated safety check: PassMIT
GitHub Code ReviewRedWoodOG/Hermes-Desktop1775 repos~3.4kAutomated safety check: NotesMIT
Fantasia Final Cleanupvishiri/fantasia-archive409—~1.2kAutomated safety check: PassGPL-3.0

Similar skills

  • Update Docs

    ArcReel/ArcReel

    根据最近的 git 改动,更新面向用户的文档(README 双语、入门教程、部署、剪映导出等)。手动调用. An agent skill from ArcReel/ArcReel.

    5.3k GitHub stars~544 tokensUpdated today
    DevelopmentAuto-check: notes
  • Merge Master

    keybase/client

    A skill your agent uses when periodically merging upstream master commits into a long-running refactor branch where code has moved, been renamed, or restructured — guiding careful per-commit…

    9.3k GitHub stars~1.3k tokensUpdated today
    DevelopmentAuto-check passed
  • Sets facade-specific YARD documentation rules for the Git::Repository public API, layered on the gem's general YARD skill.

    1.8k GitHub stars~5k tokensUpdated 5 days ago
    DevelopmentAuto-check passed
  • GitHub Code Review

    RedWoodOG/Hermes-Desktop

    Review code changes by analyzing git diffs, leaving inline comments on PRs, and performing thorough pre-push review.

    177 GitHub starsUsed in 5 repos~3.4k tokens
    DevelopmentAuto-check: notes
  • Fantasia Final Cleanup

    vishiri/fantasia-archive

    End-of-batch ship workflow for Fantasia Archive: run full yarn testbatch:verify (not dev scoped gate), fix failures, sync README/AGENTS/rules/skills from Git changes, update in-app changelog, split…

    409 GitHub stars~1.2k tokensUpdated 5 days ago
    DevelopmentAuto-check passed
  • Migrates a command class that still performs parsing or custom execution logic to return raw Git::CommandLine::Result, moving parsing to facade/parser layers.

    1.8k GitHub stars~1.3k tokensUpdated 5 days ago
    DevelopmentAuto-check passed

More from QwenLM/qwen-code

All 41 skills in this repo
  • Reproduces a feature from Codex or Claude Code in Qwen Code by running the reference agent under capture, reading the traces, then implementing matching behavior.

    28k GitHub stars~1.5k tokensUpdated today
    Auto-check passed
  • Qwen Code E2E Testing

    QwenLM/qwen-code

    Guides end-to-end testing of the Qwen Code CLI in headless mode with real model calls, MCP test servers and inspection of raw API traffic.

    28k GitHub stars~2.1k tokensUpdated today
    Auto-check passed
  • Scheduled CI skill that scans a repository for small, certain docs, test and code hygiene issues and fixes them on one branch with a commit per finding.

    28k GitHub stars~1.7k tokensUpdated today
    Auto-check passed
  • Builds a rebranded Qwen Code desktop package from the Tauri shell using only a brand id and a logo, with sensible derived defaults.

    28k GitHub stars~2.1k tokensUpdated today
    Auto-check passed
  • Walks through capturing and comparing V8 heap snapshots to find memory leaks in the Qwen Code Node.js CLI, using tmux and the chrome-devtools CLI.

    28k GitHub stars~1.3k tokensUpdated today
    Auto-check passed
  • tmux Real User Testing

    QwenLM/qwen-code

    Drives Qwen Code in a real tmux session the way a user would and saves a readable step-by-step transcript of each screen for maintainers to review.

    28k GitHub stars~2.3k tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Docs Update from Diff

What does Docs Update from Diff do?

Reads local git changes and updates only the matching docs pages, so documentation stays in sync with uncommitted or recent code changes. The skill starts from `git status --short`, `git diff --stat` and targeted `git diff` output rather than assumptions, focusing on non-doc changes first so any documentation update is grounded in real code. For each changed behavior it extracts what documentation must now reflect: a new command, flag, config key, default or limitation, a rename or removal, changed examples or setup steps, or a feature that belongs on an existing page but is not mentioned yet.

When should I use Docs Update from Diff?

Docs Update from Diff fits situations like: documenting uncommitted local changes before opening a pull request; syncing docs with a recent feature or refactor; updating docs to match a git diff instead of writing from scratch.

How do I install Docs Update from Diff in Claude Code?

Run `npx skills add QwenLM/qwen-code --skill docs-update-from-diff -a claude-code`. Or copy the skill folder (.qwen/skills/docs-update-from-diff in QwenLM/qwen-code) into .claude/skills/docs-update-from-diff in your project. Claude Code loads it when a task matches its description.

How do I install Docs Update from Diff in Codex?

Run `npx skills add QwenLM/qwen-code --skill docs-update-from-diff -a codex`. Or copy the skill folder (.qwen/skills/docs-update-from-diff in QwenLM/qwen-code) into .agents/skills/docs-update-from-diff in your project. Codex loads it when a task matches its description.

Can I use Docs Update from Diff in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add QwenLM/qwen-code --skill docs-update-from-diff -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-update-from-diff, .gemini/skills/docs-update-from-diff, .github/skills/docs-update-from-diff and .opencode/skills/docs-update-from-diff in your project.

What does Docs Update from Diff need to run?

Going by SKILL.md and its folder, Docs Update from Diff needs the command-line tools its instructions call (git). Our summary lists: A Git repository with local changes to inspect.

Does Docs Update from Diff access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Docs Update from Diff safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs Update from Diff use?

Docs Update from Diff is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Update from Diff use?

About 1.1k tokens (SKILL.md is roughly 4.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 731 tokens, read only when the agent opens those files.

What are the alternatives to Docs Update from Diff?

Skills that share tags, products or a category with Docs Update from Diff: Update Docs (ArcReel/ArcReel, 5.3k stars), Merge Master (keybase/client, 9.3k stars), Facade YARD Documentation Rules (ruby-git/ruby-git, 1.8k stars) and GitHub Code Review (RedWoodOG/Hermes-Desktop, 177 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Update from Diff?

QwenLM (a GitHub organization) maintains it in QwenLM/qwen-code, which has 28,337 GitHub stars. The repository holds 41 skills in this directory. The repository was last updated on October 7, 2026.

Source: QwenLM/qwen-code on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.