文档同步

文档 社区

技能解读

当前原文的自动摘译,尚未人工审校。

必读内容

AGENTS.md .github/instructions/docs.instructions.md 更改的实现/工作流程文件 提及更改行为的现有文档 CHANGELOG.md 当更改是用户可见、操作员可见、面向发布或面向工作流程时

主要文档目标

README.md API_DOCUMENTATION.md TESTING.md CHANGELOG.md docs/ARCHITECTURE.md

护栏

与创建新文件相比,更喜欢编辑现有文档。不要记录理想的行为;仅发送文档或明确计划的工作流程。不要复制大的部分。交叉引用事实来源。保持示例可运行并与当前存储库命令保持一致。明确记下外部先决条件,例如 Azure、Neo4j、PostgreSQL、Foundry 或部署的托管

工艺流程

从更改的文件和用户可见/操作员可见的行为中识别受影响的文档。跨文档、Copilot 说明、座席、技能和 PR 模板搜索过时的参考。使用精确的路径、命令、环境变量和约束更新现有部分。仅当行为或工作流程对用户、操作员或维护人员很重要时才添加更改日志条目。验证文档之间没有矛盾的陈述。

验证

运行git diff --check解决文本格式问题。检查更改涉及的 Markdown 标题、链接、命令和示例。对于从实现生成的文档,请运行现有的生成器/检查命令(如果存在)。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@tomevault-io · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 读取环境变量
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

作者说明文件(原文) SKILL.md

# QPrisma Documentation Sync Skill

Use this skill when code, APIs, workflows, architecture, evaluation behavior, or maintainer process
changes.

## Required reads

1. `AGENTS.md`
2. `.github/instructions/docs.instructions.md`
3. Changed implementation/workflow files
4. Existing docs that mention the changed behavior
5. `CHANGELOG.md` when the change is user-visible, operator-visible, release-facing, or workflow-facing

## Primary documentation targets

- `README.md`
- `API_DOCUMENTATION.md`
- `TESTING.md`
- `CHANGELOG.md`
- `docs/ARCHITECTURE.md`
- `docs/BACKEND_ARCHITECTURE.md`
- `docs/INFRASTRUCTURE.md`
- `docs/MEMORY_ARCHITECTURE.md`
- `backend/agent/ARCHITECTURE.md`
- `.github/copilot-instructions.md`
- `.github/agents/*.agent.md`
- `.github/skills/*/SKILL.md`
- `.github/PULL_REQUEST_TEMPLATE.md`

## Guardrails

- Prefer edits to existing docs over creating new files.
- Do not document aspirational behavior; document shipped or explicitly planned workflow only.
- Do not duplicate large sections. Cross-reference the source of truth.
- Keep examples runnable and aligned with current repository commands.
- Explicitly note external prerequisites such as Azure, Neo4j, PostgreSQL, Foundry, or deployed hosted
  agent.
- Redact private values in examples and evidence.

## Process

1. Identify impacted docs from changed files and user-visible/operator-visible behavior.
2. Search for stale references across docs, Copilot instructions, agents, skills, and PR templates.
3. Update existing sections with precise paths, commands, environment variables, and constraints.
4. Add changelog entries only when the behavior or workflow matters to users, operators, or maintainers.
5. Verify there are no contradictory statements across docs.

## Validation

- Run `git diff --check` for text formatting issues.
- Inspect Markdown headings, links, commands, and examples touched by the change.
- For docs generated from implementation, run the existing generator/check command if one exists.

## Output format

```markdown
### Updated docs
- `path`: change summary

### Consistency checks
- ...

### Remaining gaps
- ...
```

---
> Source: [alexandergg/QPrisma](https://github.com/alexandergg/QPrisma) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-23 -->

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。