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
포크
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에서 보기