跳到正文
cccskills
免费在 GitHub 公开

frontend-to-backend-requirements

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.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(2)

  • SKILL.md5.5 KB
  • README.md5.0 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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/<feature-name>/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 OwnsBackend Owns
What data is neededHow data is structured
What actions existEndpoint design
UI states to handleField names, types
User-facing validationAPI conventions
Display requirementsPerformance/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/<feature-name>/backend-requirements.md:

# Backend Requirements: <Feature Name>

## Context
[What we're building, who it's for, what problem it solves]

## Screens/Components

### <Screen/Component Name>
**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]

### <Next Screen/Component>
...

## 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.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Refactor bloated AGENTS.md, CLAUDE.md, or similar agent instruction files to follow progressive disclosure principles. Splits monolithic files into organized, linked documentation.

中文简介正在准备中。当前显示原文说明。

softaworks/agent-toolkit25832026年3月6日 更新

Create API handoff documentation for frontend developers. Use when backend work is complete and needs to be documented for frontend integration, or user says 'create handoff', 'document API', 'frontend handoff', or 'API documentation'.

中文简介正在准备中。当前显示原文说明。

softaworks/agent-toolkit25832026年3月6日 更新

Generate architecture documentation using C4 model Mermaid diagrams. Use when asked to create architecture diagrams, document system architecture, visualize software structure, create C4 diagrams, or generate context/container/component/deployment diagrams. Triggers include "architecture diagram", "C4 diagram", "system context", "container diagram", "component diagram", "deployment diagram", "document architecture", "visualize architecture".

中文简介正在准备中。当前显示原文说明。

softaworks/agent-toolkit25832026年3月6日 更新

codex

免费

Use when the user asks to run Codex CLI (codex exec, codex resume) or references OpenAI Codex for code analysis, refactoring, or automated editing. Uses GPT-5.2 by default for state-of-the-art software engineering.

中文简介正在准备中。当前显示原文说明。

softaworks/agent-toolkit25832026年3月6日 更新

This skill should be used when creating a Claude Code slash command. Use when users ask to "create a command", "make a slash command", "add a command", or want to document a workflow as a reusable command. Essential for creating optimized, agent-executable slash commands with proper structure and best practices.

中文简介正在准备中。当前显示原文说明。

softaworks/agent-toolkit25832026年3月6日 更新

Create high-quality git commits: review/stage intended changes, split into logical commits, and write clear commit messages (including Conventional Commits). Use when the user asks to commit, craft a commit message, stage changes, or split work into multiple commits.

中文简介正在准备中。当前显示原文说明。

softaworks/agent-toolkit25832026年3月6日 更新

查看 softaworks 的全部技能

报告此技能的问题