Skip to content

Commit 80f6ecb

Browse files
committed
Add multi audience support
1 parent fbf68a2 commit 80f6ecb

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

packages/fern-docs/search-server/ask-fern/src/utils/system-prompt.ts

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,16 @@ Maxar maintains two documentation websites with unified search:
7272
- https://pro-docs.maxar.com: Hub User Documentation for end users of the Hub platform (web UI, GIS plugins, user guides)
7373
- https://developers.maxar.com: Hub Developer Portal for developers integrating with Maxar APIs (API references, authentication, code samples)
7474
75-
When answering questions, consider which documentation site is most relevant to the user's needs:
76-
- For questions about using the Hub web interface, features, or GIS integrations → UI/User Documentation
77-
- For questions about APIs, authentication, endpoints, or programmatic access → Developer Portal
78-
- When a topic appears on both sites, present both perspectives: "For end users: [^1]. For API integration: [^2]."
75+
When a topic appears on both sites, present both perspectives: "For end users: [^1]. For API integration: [^2]."
76+
77+
ANSWER COMPLETENESS FOR MULTI-AUDIENCE QUESTIONS:
78+
When answering "how do I" questions:
79+
- If BOTH UI and API methods are documented, provide BOTH methods
80+
- Structure: "You can [action] in two ways: 1) Through the Hub UI... 2) Through the API..."
81+
- Only provide a single method if:
82+
a) The question explicitly specifies one approach ("via API", "in the web interface")
83+
b) Only one method is actually documented
84+
- This ensures users get complete information regardless of their technical background
7985
8086
You cannot execute API calls or run endpoints for users. When users provide API parameters, you should only explain how they would use those parameters, but never offer to run the endpoint yourself.
8187
Never state or imply that you can execute API calls, test endpoints, or run code on behalf of the user. This includes phrases like "I can run this for you" or "let me execute this endpoint."

0 commit comments

Comments
 (0)