frontend-to-backend-requirements
Scannednpx machina-cli add skill softaworks/agent-toolkit/frontend-to-backend-requirements --openclawBackend 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.mdNo 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:
- What is this? — Screen, flow, component
- Who uses it? — User type, permissions
- 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:
- Add responses to Discussion Log
- Adjust requirements based on feedback
- Mark resolved uncertainties
- Note any decisions made
The doc becomes the source of truth for what was agreed.
Source
git clone https://github.com/softaworks/agent-toolkit/blob/main/skills/frontend-to-backend-requirements/SKILL.mdView on GitHub Overview
This skill guides frontend developers to document the data they need from the backend, focusing on what to display, what actions are allowed, and which UI states matter. It emphasizes collaboration with backend teams and avoids implementation details, ensuring clear data requirements without exposing endpoints.
How This Skill Works
Follow a feature-led workflow: describe the feature, list data needs (display data, user actions, UI states), surface uncertainties, and leave room for discussion. The result is a backend-requirements.md style document that communicates data expectations while keeping backend implementation out of scope.
When to Use It
- When you need to specify exactly what data is required to render a screen or component.
- When a user asks for 'backend requirements', 'what data do I need', or 'API requirements'.
- When you want to outline actions and the resulting UI feedback without describing endpoints.
- When you must surface uncertainties or edge cases for backend clarification.
- When preparing a collaborative artifact for review (the .claude/docs ... backend-requirements.md).
Quick Start
- Step 1: Describe the Feature — What is this UI, who uses it, and what success looks like?
- Step 2: List Data Needs — Detail data to display, user actions, and UI states (loading, empty, error).
- Step 3: Surface Uncertainties & Discussion — Note unclear business rules and pose questions for backend feedback.
Best Practices
- Describe data pieces in UI terms, not database field names.
- Specify actions and the expected outcomes or UI feedback for each action.
- Define UI states (loading, empty, error) and common edge cases clearly.
- Separate frontend data needs from backend data structure and endpoint design.
- End with open questions to invite backend clarification and discussion.
Example Use Cases
- Document a screen that lists items: describe the data pieces shown, their relationships, and how visibility is determined.
- Outline a detail view requiring related data and explain how user actions update the UI and what feedback is shown.
- Describe a search or results screen: what data is needed for results, loading indicators, and empty state messaging.
- Summarize a multi-step form: data prefill rules, required actions, and success/failure feedback.
- Explain a permission-based UI: which data and actions appear for different user roles and how visibility changes with roles.