From 6e3a5df0fadeef42779eb0368f89024207454b0e Mon Sep 17 00:00:00 2001 From: Chen Zheng Date: Mon, 1 Jun 2026 14:38:49 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B1=89=E5=8C=96README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c81926b..94a2585 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # fanwei-e10-api-doc -This skill generates external-facing Markdown API documentation for 泛微 OA E10 OpenAPI integrations. +该 Skill 用于为泛微 OA E10 OpenAPI 集成生成面向外部开发者的 Markdown API 文档。 -It is optimized for workflow-instance API documentation: authenticating to E10 in a read-only browser session, reading OpenAPI documentation, discovering workflow form fields, mapping E10 field types to external payload guidance, and producing a developer-ready Markdown document. +它针对“流程实例”相关 API 文档进行了优化，覆盖以下场景：在只读浏览器会话中完成 E10 认证、阅读 OpenAPI 文档、发现流程表单字段、将 E10 字段类型映射为外部请求参数说明，并最终生成可供开发者直接使用的 Markdown 文档。 -## Contents +## 内容 -- `SKILL.md`: routing, workflow, safety boundary, and resource guide. -- `references/`: detailed operational references and documentation standards. -- `assets/templates/`: reusable output template. -- `examples/`: sanitized sample prompt, extracted metadata, and output style. -- `evals/`: trigger and quality checks. +- `SKILL.md`：路由规则、工作流程、安全边界和资源指南。 +- `references/`：详细的操作参考和文档编写标准。 +- `assets/templates/`：可复用的输出模板。 +- `examples/`：脱敏后的示例提示词、提取出的元数据和输出风格示例。 +- `evals/`：触发条件和质量检查。 -## Safety +## 安全要求 -The skill is explicitly read-only. It must not create, update, delete, publish, submit, approve, or reject any E10 object or data. +该 Skill 明确限定为只读。它不得创建、更新、删除、发布、提交、批准或驳回任何 E10 对象或数据。 -Final documentation must not expose real credentials, tokens, hostnames, database tables, internal API paths, or E10 management implementation details. +最终生成的文档不得暴露真实凭据、令牌、主机名、数据库表、内部 API 路径或 E10 管理端实现细节。