文档安装
- 作者仓库星标 1,897
- 作者更新于 实时读取
- 作者仓库 skillshare
- 领域
- 文档
- 兼容 Agent
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- 信任分
- 88 / 100 · 社区维护
- 作者 / 版本 / 许可
- @runkids · 未声明 license
- Token 消耗评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部 API Key
- 不需要
- 兼容的系统
- macOS · Linux · Windows
- 底层运行要求
- 无特殊要求
- 文件与系统权限
-
- 只读
- 允许写入 / 修改
- 网络行为
- 仅限本地
- 安装命令数
- 26 条
档案由构建时根据 SKILL.md 与安装命令自动衍生,可能与作者实际意图存在差异。
需要注意: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: skillshare-update-docs
description: >- Sync website documentation with recent code changes. $ARGUMENTS specifies scope: a command na…
category: 文档
runtime: 无特殊运行时
---
# skillshare-update-docs 输出预览
## PART A: 任务判断
- 适用问题:PRD、RFC、README、项目说明或知识库整理。
- 输入要求:目标材料、限制条件、期望输出和验收方式。
- 证据边界:围绕“Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags”读取原文规则,不把推断写成作者承诺。
## PART B: 执行结果
- **01** 任务判断:确认你的需求是否属于PRD、RFC、README、项目说明或知识库整理,并标出输入、限制和预期结果。
- **02** 执行计划:优先按“Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags”拆成步骤,说明每一步会读取什么、修改什么、产出什么。
- **03** 交付结果:给出可复制的命令、文件改动、检查清单或内容草稿,并说明如何继续迭代。
- **04** 风险边界:结合 读取文件、写入/修改文件、主要在本地完成、通常不需要额外 API Key 给出执行前确认项。
## Running Rules
- 读取文件、写入/修改文件;主要在本地完成;通常不需要额外 API Key。
- 先小样例验证,再放大到真实任务。
- 交付时同时给结果、检查口径和下一步迭代建议。 原文没有稳定的斜杠命令要求。安装验证后通常全局生效,直接在对话里点名这个 Skill 并描述任务即可。
告诉 Agent 目标文件或材料、期望结果、不可改范围、是否允许联网或执行命令。本 Skill 的权限画像是:读取文件、写入/修改文件。
先用一个小任务确认它会围绕“Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags”工作;涉及文件或命令时,先看 diff、日志、预览或测试结果。
检查最终产物是否包含明确结果、必要证据和下一步动作;如果输出泛泛而谈,就补充输入、边界和验收标准后重跑。
---
name: skillshare-update-docs
description: >- Sync website documentation with recent code changes. $ARGUMENTS specifies scope: a command na…
category: 文档
source: runkids/skillshare
---
# skillshare-update-docs
## 什么时候使用
- 把项目文档方向的常用动作沉淀成 Agent 可调用的技能 适合处理README、PRD、RFC、教程和知识库文档,核心价值是把输入、判断、执行、验证和交付边界固定下来,避免 Agent 泛泛回答。 把任务拆成可执行、可检查、可继续迭代的…
- 面向PRD、RFC、README、项目说明或知识库整理,优先处理能明确输入、步骤和验收标准的工作。
## 需要提供什么
- 目标材料、目录范围、期望结果和不可改动内容。
- 是否允许联网、执行命令、读写文件或调用外部服务。
## 执行规则
- 围绕「Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags」组织步骤,不把推断写成作者事实。
- 读取文件、写入/修改文件;主要在本地完成;通常不需要额外 API Key。
- 先跑小样例,确认结果可检查后再扩大任务范围。
## 输出要求
- 给出最终产物、关键证据、验证方式和下一步动作。
- 信息不足时标记 unknown,不编造命令、平台或依赖。 作者原文负责流程事实;仓库文件负责来源和命令;流狐只补充适用场景、限制和质量判断。
skill "skillshare-update-docs" {
输入层 -> 用户目标 + 目标文件 + 禁止范围 + 验收标准
上下文层 -> Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags
规则层 -> SKILL.md 触发条件 / 执行顺序 / 输出格式
运行层 -> 无特殊运行时 | 读取文件、写入/修改文件 | 主要在本地完成
安全层 -> 通常不需要额外 API Key + 小任务验证 + diff / 日志复核
输出层 -> 可复制结果 + 检查清单 + 下一步迭代
} Sync website documentation with recent code changes. $ARGUMENTS specifies scope: a command name (e.g., install), commit range, or omit to auto-detect from git diff HEAD~1.
Scope: This skill only updates website/docs/. It does NOT write Go code (use implement-feature) or CHANGELOG (use changelog).
Workflow
Step 1: Detect Changes
# Auto-detect recently changed code
git diff HEAD~1 --stat -- cmd/skillshare/ internal/
# Also check for structural changes that affect concept/reference docs
git diff HEAD~1 --stat -- internal/config/targets.yaml internal/audit/rules.yaml
Map changed files to affected documentation using this guide:
Command docs (website/docs/reference/commands/):
cmd/skillshare/<cmd>.go→website/docs/reference/commands/<cmd>.md- Flag changes, new subcommands, output format changes
Concept docs (website/docs/understand/):
internal/audit/→understand/audit-engine.mdinternal/sync/→understand/sync-modes.md,understand/source-and-targets.mdinternal/install/tracked.go→understand/tracked-repositories.mdinternal/config/→understand/declarative-manifest.md.skillshare/project config changes →understand/project-skills.mdskills/skillshare/SKILL.mdformat →understand/skill-format.md
Reference docs (website/docs/reference/):
internal/config/targets.yaml→reference/targets/internal/audit/rules.yaml→reference/commands/audit-rules.mdreference/appendix/for CLI quick-reference tables
How-to guides (website/docs/how-to/):
- New workflow patterns →
how-to/daily-tasks/,how-to/advanced/,how-to/recipes/ - Sharing/org features →
how-to/sharing/
Troubleshooting (website/docs/troubleshooting/):
- New error messages →
troubleshooting/common-errors.md - FAQ additions →
troubleshooting/faq.md
Getting started (website/docs/getting-started/):
- Breaking changes to init/install flow →
getting-started/first-sync.md - Quick reference updates →
getting-started/quick-reference.md
Learn (website/docs/learn/):
- New target integrations →
learn/with-<tool>.md
Step 2: Cross-Validate Flags
For each affected command:
Read the Go source to extract actual flags and behavior:
grep -n 'flag\.\|Usage\|Args' cmd/skillshare/<cmd>.goRead the corresponding doc page:
website/docs/commands/<cmd>.mdCompare and fix:
- New flags in code → add to docs with usage example
- Removed flags from code → remove from docs
- Changed behavior → update description
- Every
--flagin docs must have a matchinggrephit in source
Step 3: Update Documentation
Apply changes following existing doc conventions:
- Match heading structure of neighboring doc pages
- Include CLI examples with expected output
- Keep flag tables consistent in format
Step 4: Check Built-in Skill
If changes affect user-visible CLI behavior:
- Read
skills/skillshare/SKILL.md - Check if the built-in skill description needs updating
- Verify description stays under 1024 characters (CodeX limit)
Step 5: Check README
Review README.md for sections that may need updates:
- Recent Updates callout
- Why skillshare bullet points (5 selling points)
- Highlights section (core feature examples)
Step 6: Build Verification
cd website && npm run build
Confirm no broken links or build errors.
Step 7: Report
List all changes made with rationale:
== Documentation Updates ==
Modified:
website/docs/commands/install.md
- Added --into flag documentation
- Updated install examples
skills/skillshare/SKILL.md
- Added --into to feature list (desc: 987/1024 chars)
Build: PASS (no broken links)
Rules
- Source of truth is code — docs must match what the code actually does
- Every flag claim must be verified — grep source before writing docs
- No speculative docs — never document planned but unimplemented features
- No code changes — this skill only touches
website/docs/,skills/skillshare/SKILL.md, andREADME.md - Preserve style — match existing doc page structure and tone
- Built-in skill desc limit — must stay under 1024 characters
先判断是否适合
作者设计意图
作者的方法与取舍
边界和复核