跳到主内容
智客 ZICQ

技能库 智客分类:文档办公 frontend-to-backend-requirements

Frontend To Backend Requirements

后端开发者的文档前端数据需求. 当前端需要将API要求传递到后端时使用,或者用户说"后端要求","我需要什么数据","API要求",或者正在描述一个UI的数据需要.

740 安装量

官方网址:skills.sh

技能介绍

先看中文介绍;官方 description 原文单独保留,不改写 SKILL.md。

做什么

后端开发者的文档前端数据需求

何时用

前端需要将 API 要求传递到后端, 或者用户说“ 后端要求 ” , “ 我需要什么数据 ” , “ API 要求 ” , 或者正在描述一个 UI 的数据需求

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:Backend Requirements Mode、The Point、What You Own vs. What Backend Owns、Workflow、Step 1: Describe the Feature、Step 2: List Data Needs。 其中含规范建议的小节:分步指令。

文件分析

文件分析:这是一份仅含 SKILL.md 的指令型技能,代理激活后整份正文进入上下文。

官方 description(原文)

Document frontend data needs for backend developers. Use when frontend needs to communicate API requirements to backend, or user says 'backend requirements', 'what data do I need', 'API requirements', or is describing data needs for a UI.

Backend Requirements ModeThe PointWhat You Own vs. What Backend OwnsWorkflowStep 1: Describe the FeatureStep 2: List Data NeedsStep 3: Surface UncertaintiesStep 4: Leave Room for DiscussionOutput FormatBackend Requirements: <Feature Name>ContextScreens/Components

来源分类:skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
name
frontend-to-backend-requirements
description
Document frontend data needs for backend developers. Use when frontend needs to communicate API requirements to backend, or user says 'backend requirements', 'what data do I need', 'API requirements', or is describing data needs for a UI.
  1. 发现技能客户端向 Agent 提供名称与描述目录。
  2. 匹配与调用用户指定或任务匹配后,载入 SKILL.md 指令。
  3. 按需加载按步骤读取参考文档、使用脚本与素材。

具体调用语法与可用工具以目标 Agent 客户端为准。 查看调用机制说明 ↗

安装这个技能

Skills CLI ↗

先选择目标 Agent 和安装范围,保留技能包的附属文件,安装后检查客户端能否发现该技能。

交给 Agent 安装

复制安装指令给支持 Agent Skills 的代理,确认其中的目标目录与客户端匹配。

把 Agent Skill「frontend-to-backend-requirements」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-77af89cc08481c37-%E5%89%8D%E7%AB%AF%E5%88%B0%E5%90%8E%E7%AB%AF%E9%9C%80%E6%B1%82.html
请存为 .cursor/skills/frontend-to-backend-requirements/SKILL.md 或 .claude/skills/frontend-to-backend-requirements/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。

GitHub 完整包 ↗

终端安装 · Skills CLI

需要 Node.js 与 npx。先查看仓库技能列表,确认实际名称。

npx skills add 'https://github.com/softaworks/agent-toolkit' --list

npx skills add 'https://github.com/softaworks/agent-toolkit' --skill 'frontend-to-backend-requirements'

CLI 会交互选择目标 Agent,默认安装到项目;用户级安装使用 -g。先通过查看命令核对仓库内容,再用 npx skills list 检查已安装技能。

阅读排版
--- name: frontend-to-backend-requirements description: Document frontend data needs for backend developers. Use when frontend needs to communicate API requirements to backend, or user says 'backend requirements', 'what data do I need', 'API requirements', or is describing data needs for a UI. --- # Backend Requirements Mode You are a frontend developer documenting what data you need from backend. You describe the **what**, not the **how**. Backend owns implementation details. > **No Chat Output**: ALL responses go to `.claude/docs/ai//backend-requirements.md` > **No Implementation Details**: Don't specify endpoints, field names, or API structure—that's backend's call. --- ## The Point This mode is for frontend devs to communicate data needs: - What data do I need to render this screen? - What actions should the user be able to perform? - What business rules affect the UI? - What states and errors should I handle? **You're requesting, not demanding.** Backend may push back, suggest alternatives, or ask clarifying questions. That's healthy collaboration. --- ## What You Own vs. What Backend Owns | Frontend Owns | Backend Owns | |---------------|--------------| | What data is needed | How data is structured | | What actions exist | Endpoint design | | UI states to handle | Field names, types | | User-facing validation | API conventions | | Display requirements | Performance/caching | --- ## Workflow ### Step 1: Describe the Feature Before listing requirements: 1. **What is this?** — Screen, flow, component 2. **Who uses it?** — User type, permissions 3. **What's the goal?** — What does success look like? ### Step 2: List Data Needs For each screen/component, describe: **Data I need to display:** - What information appears on screen? - What's the relationship between pieces? - What determines visibility/state? **Actions user can perform:** - What can the user do? - What's the expected outcome? - What feedback should they see? **States I need to handle:** - Loading, empty, error, success - Edge cases (partial data, expired, etc.) ### Step 3: Surface Uncertainties List what you're unsure about: - Business rules you don't fully understand - Edge cases you're not sure how to handle - Places where you're guessing **These invite backend to clarify or push back.** ### Step 4: Leave Room for Discussion End with open questions: - "Would it make sense to...?" - "Should I expect...?" - "Is there a simpler way to...?" --- ## Output Format Create `.claude/docs/ai//backend-requirements.md`: ```markdown # Backend Requirements: ## Context [What we're building, who it's for, what problem it solves] ## Screens/Components ### **Purpose**: What this screen does **Data I need to display**: - [Description of data piece, not field name] - [Another piece] - [Relationships between pieces] **Actions**: - [Action description] → [Expected outcome] - [Another action] → [Expected outcome] **States to handle**: - **Empty**: [When/why this happens] - **Loading**: [What's being fetched] - **Error**: [What can go wrong, what user sees] - **Special**: [Any edge cases] **Business rules affecting UI**: - [Rule that changes what's visible/enabled] - [Permissions that affect actions] ### ... ## Uncertainties - [ ] Not sure if [X] should show when [Y] - [ ] Don't understand the business rule for [Z] - [ ] Guessing that [A] means [B] ## Questions for Backend - Would it make sense to combine [X] and [Y]? - Should I expect [Z] to always be present? - Is there existing data I can reuse for [W]? ## Discussion Log [Backend responses, decisions made, changes to requirements] ``` --- ## Good vs. Bad Requests ### Bad (Dictating Implementation) > "I need a GET /api/contracts endpoint that returns an array with fields: id, title, status, created_at" ### Good (Describing Needs) > "I need to show a list of contracts. Each item shows the contract title, its current status, and when it was created. User should be able to filter by status." ### Bad (Assuming Structure) > "The provider object should be nested inside the contract response" ### Good (Describing Relationship) > "For each contract, I need to show who the provider is (their name and maybe logo)" ### Bad (No Context) > "I need contract data" ### Good (With Context) > "On the dashboard, there's a 'Recent Contracts' widget showing the 5 most recent contracts. User clicks one to go to detail page." --- ## Encouraging Pushback Include these prompts in your requirements: - "Let me know if this doesn't make sense for how the data is structured" - "Open to suggestions on a better approach" - "Not sure if this is the right way to think about it" - "Push back if this complicates things unnecessarily" **Good collaboration = frontend describes the problem, backend proposes the solution.** --- ## Rules - **NO IMPLEMENTATION DETAILS**—don't specify endpoints, methods, field names - **DESCRIBE, DON'T PRESCRIBE**—say what you need, not how to provide it - **INCLUDE CONTEXT**—why you need it helps backend make better choices - **SURFACE UNKNOWNS**—don't hide confusion, invite clarification - **INVITE PUSHBACK**—explicitly ask for backend's input - **UPDATE THE DOC**—add backend responses to Discussion Log - **STAY HUMBLE**—you're asking, not demanding --- ## After Backend Responds Update the requirements doc: 1. Add responses to Discussion Log 2. Adjust requirements based on feedback 3. Mark resolved uncertainties 4. Note any decisions made The doc becomes the source of truth for what was agreed.

相关技能

文档办公

Ontology

为结构化的代理内存和可堆肥技能所打入的知识图. 在创建/征服实体(Person, project, Task, Evention, Document)时使用,链接相关对象,强制约束,规划多步动作作为图变,或技能需要共享状态时使用. 触发到"记住","我知道什么","链接X到Y",…

文档办公

Nano Pdf

使用纳米-pdf CLI编辑带有自然语言指令的PDF.

文档办公

Word / DOCX

创建,检查,并编辑有可靠样式的Microsoft Word文档和DOCX文件,编号,跟踪更改,表格,章节,并进行相容性检查. 当 (1) 任务涉及 Word 或 ".docx " 时使用; (2) 文件包括跟踪的更改,评论,字段,表格,模板,或页面布局限制; (3) 文档必须在不…

文档办公

Api Gateway

通过 Maton 网关调用第三方 API, 它为用户已经连接的应用程序注入证书 。 当用户命名一个连接的应用程序和其中的具体行动时使用此技能——读取一个邮箱,查询一个CMM,归档一个问题,更新一个电子表格,通过一个连接的搜索或刮取提供者运行一个查询. 每一次通话都到用户连接的应用…