Superapp / Product requirements / example
Example Domain — product requirements
Example Domain is the reserved documentation domain page: one short paragraph, translations of it, an icon and a single "Learn more" link to an explanation page. It deliberately has no navigation, logo or search.
Problem. Writers of documentation need a domain they can use in examples without permission, and readers who land on it need a short, unambiguous explanation of why it exists.
Users
- Documentation reader — Understand at a glance that this domain is only for examples and find out more.
- Translator or screen-reader user — Get each language version correctly tagged.
Goals
- The page stays minimal: one heading, one paragraph, one link.
- The same page serves .com, .net and .org variants.
Out of scope
- The linked reference site (covered by its own product spec)
Contents
Page content
Title, icon, paragraph, translations and structure.
FR-PAG-01
MustThe page at /example/ has the document title "Example Domain", an icon labelled "Example icon", the paragraph and exactly one link.
- Paragraph: "This domain is for use in documentation examples without needing permission. Avoid use in operations."
- Exactly one link, "Learn more"
FR-PAG-02
ShouldTranslations of the paragraph are listed in a fixed order and each declares its language.
- Five items with lang es, fr, de, vi, ja in that order
- The vi item reads "Tên miền này dùng cho ví dụ trong tài liệu mà không cần xin phép. Tránh dùng trong vận hành."
- The html element has lang="en"
FR-PAG-03
ShouldThe page has no site chrome and a single heading.
- No nav, header or search box
- Exactly one h1 "Example Domain"; content sits in a single main element
Domain variants
The ?domain= parameter.
FR-VAR-01
ShouldThe .com, .net and .org variants share the same content and differ only in the description meta.
- ?domain=net: description "example.net"
- ?domain=org: description "example.org"
- Any other value, or none, falls back to "example.com"
Learn more link
The single outbound link.
FR-LNK-01
Must"Learn more" opens the example-domains explanation page.
- URL /registry/help/example-domains, heading "Example Domains", document title "Example Domains"
- Back returns to the documentation page
Non-functional requirements
NFR-01
CouldOn a 375 px wide phone the content keeps a 16 px side gutter and does not scroll sideways; on desktop the content column is centred and at most 640 px wide.