Skip to main content

docs-sync

Update user or maintainer documentation to match observed software behavior and commands. Use for documentation drift and feature handoffs; avoid speculative or unrelated rewriting.

来源信息

仓库
itsofficialadi/boundiff
最近来源活动
2026年10月22日 06:20
检测到的 SKILL.md 语言
英语
星标
0
Forks
0

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
docs-sync
description
Update user or maintainer documentation to match observed software behavior and commands. Use for documentation drift and feature handoffs; avoid speculative or unrelated rewriting.
# Documentation sync Documentation should describe the software that exists, not the feature as originally imagined. 1. Identify the change, intended reader, relevant entry points, actual config/CLI/API behavior, and current documentation. 2. Verify names, flags, environment variables, examples, version requirements, and error cases against source or a runnable command where practical. 3. Edit only impacted sections. Prefer a working example with realistic input and output over vague adjectives. Preserve the project's voice and established formatting. 4. Ensure installation examples do not overwrite existing files without warning, pipe unreviewed remote scripts into a shell, or require unnecessary privileges. 5. Check local links, code fences, command examples, and the diff. If code and docs disagree, report the mismatch rather than fabricating intended behavior. 6. Distinguish commands **executed** from commands **documented but not run** in the final handoff. ## Output **Readers affected**, **documentation paths**, **behavioral evidence**, **example checks**, and **known gaps**. Never claim an integration works because its README says so.
在 GitHub 查看