docs-writing

docs-writing is a skill for Claude Code, Codex from zhouguoqing/QianYuan.AIAgenticFramework. It costs 19 tokens per session (151 once invoked), scanned A, original, Apache-2.0.

A guide for writing concise documentation for developers, including README files, setup guides, usage instructions, and changelogs. It focuses on helping readers take their next practical action.

In plain words
What is it for?
Use it to write or revise developer documentation, add concrete examples, explain configuration, describe usage, document troubleshooting, and record release changes.
Why use it?
It prevents documentation from becoming vague or buried in implementation details, while making setup and troubleshooting easier to follow.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to write or revise developer documentation, add concrete examples, explain configuration, describe usage, document troubleshooting, and record release changes.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/zhouguoqing/qianyuan.aiagenticframework/docs-writing
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add zhouguoqing/QianYuan.AIAgenticFramework --skill docs-writing
Clone the repo
git clone --depth 1 https://github.com/zhouguoqing/QianYuan.AIAgenticFramework

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for docs-writing

README.md
[![agentmods](https://agentmods.dev/badge/skills/zhouguoqing/qianyuan.aiagenticframework/docs-writing/github.svg)](https://agentmods.dev/skills/zhouguoqing/qianyuan.aiagenticframework/docs-writing)
Your own site
<a href="https://agentmods.dev/skills/zhouguoqing/qianyuan.aiagenticframework/docs-writing"><img src="https://agentmods.dev/badge/skills/zhouguoqing/qianyuan.aiagenticframework/docs-writing/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for docs-writing

Your own site · 80×15
<a href="https://agentmods.dev/skills/zhouguoqing/qianyuan.aiagenticframework/docs-writing"><img src="https://agentmods.dev/badge/skills/zhouguoqing/qianyuan.aiagenticframework/docs-writing.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 19 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 151 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00019 $0.00151
Opus 5 $0.00010 $0.00076
Sonnet 5 $0.00004 $0.00030
Haiku 4.5 $0.00002 $0.00015

Measured 10d ago against content hash c02baad44acc, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

docs-writing scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 10d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

artifacts/current-working-snapshot-20260803-110837/samples/skills/docs-writing/SKILL.md · 23 lines

What it actually says

Docs Writing

Use this skill when the user asks for documentation, README updates, usage guides, release notes, or technical explanations.

Instructions

  • Write for the reader's next action.
  • Prefer concrete examples over abstract claims.
  • Keep setup, configuration, and troubleshooting steps easy to scan.
  • Avoid documenting implementation details unless they affect usage or maintenance.
  • Make caveats explicit without burying the main path.

Output Shape

Lead with the practical outcome, then show usage, configuration, and troubleshooting notes as needed.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 10d ago First seen · 23 lines · 19 tokens per session scan A c02baad44acc

Subscribe to this mod's changes

docs-writing is a skill published in the GitHub repository zhouguoqing/QianYuan.AIAgenticFramework (36 stars, last pushed 24d ago), licensed Apache-2.0. It adds 19 tokens to every session and 151 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

conversational-ux

Design voice and conversational interfaces — dialog flows, error recovery, and persona. Use when the interface speaks and listens rather than being tapped. For graphical input collection, use form-design.

Owl-Listener/designer-skills · 43 tokens

platform-conventions

Design to iOS and Android conventions — what each OS mandates, where they diverge, and when to unify. Use when shipping native apps. For breakpoint adaptation use responsive-design; for matching competitor patterns use jakobs-law (interaction-design).

Owl-Listener/designer-skills · 55 tokens

research-repository

Build a repository that makes findings findable, reusable, and cumulative across teams. Use when the same research keeps getting redone. For synthesising one study, use affinity-diagram.

Owl-Listener/designer-skills · 43 tokens

design-negotiation

Advocate for design quality, scope, and timeline with partners and leadership using evidence and shared goals. Use in the conversation itself. For the commercial vocabulary behind it, use business-design (ux-strategy).

Owl-Listener/designer-skills · 48 tokens

form-design

Design a form end to end — field order, grouping, validation, and completion. Use when the artifact is a form. For product-wide error strategy use error-handling-ux; for first-run signup use onboarding-design.

Owl-Listener/designer-skills · 51 tokens

peak-end-rule

Apply the Peak-End Rule — a flow is remembered by its most intense moment and its last. Use when designing completion, celebration, or cancellation moments. For sustaining engagement mid-flow, use zeigarnik-effect.

Owl-Listener/designer-skills · 47 tokens