Frontend To Backend Requirements

davila7/claude-code-templates/cli-tool/components/skills/enterprise-communication/frontend-to-backend-requirements

作者 davila78da17d671b6f无许可证32K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

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.

AI 生成的概览

指导前端开发者编写后端需求文档,说明所需数据、操作和界面状态。

功能
该技能引导前端开发者记录某个界面或流程需要后端提供哪些数据,而不指定接口、字段名或 API 结构。它会生成一份 Markdown 需求文档,路径为 .claude/docs/ai/ /backend-requirements.md,内容涵盖背景、界面与组件、数据需求、操作、界面状态、业务规则、不确定项和待讨论问题。文档还包含讨论记录,用于记录后端回复和已达成的决定。
适用场景
适用于前端需要向后端传达 API 或数据需求的场景,也适用于有人询问后端需求、界面需要哪些数据或 API 需求时。它适合功能规划早期,在确定实现细节之前先描述数据需求。
运行要求
不需要脚本或工具,仅为指令。它会将输出写入 .claude/docs/ai/ /backend-requirements.md 文件,因此需要对该路径的文件写入权限。

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:

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

来源与署名

来源:davila7/claude-code-templates位于cli-tool/components/skills/enterprise-communication/frontend-to-backend-requirements提交8da17d6

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架