Follow writing guidelines
skillskillsetup L1★0
phonely-ai/frontend-api-doc ↗What it does
Document API endpoints with customer-focused guides
Best for
Creating customer-facing API docs when clarity and accuracy of UI labels are non-negotiable for business users.
Inputs
- · Feature name
- · UI labels from product
- · Use case description
Outputs
- · Markdown documentation page
- · Usage examples
- · Route mappings
Requires
- · Writing framework
- · Markdown renderer
Preconditions
- · Exact UI labels available
- · Feature functionality documented
- · One canonical page per concept
Failure modes
- · Undocumented routes referenced
- · UI labels outdated
- · Inventing auth schemes not in product
Trust signals
- · Audience-specific voice (customers not engineers)
- · Exact UI label consistency
- · TODO placeholders for incomplete visuals