From 4500da339b978f7761261e2b8db83a817139415f Mon Sep 17 00:00:00 2001 From: Sam Roberts <158088236+g-samroberts@users.noreply.github.com> Date: Tue, 3 Mar 2026 12:49:18 -0800 Subject: [PATCH] Update docs-writer skill with new resource (#20917) --- .gemini/skills/docs-writer/SKILL.md | 4 ++ .../docs-writer/quota-limit-style-guide.md | 45 +++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 .gemini/skills/docs-writer/quota-limit-style-guide.md diff --git a/.gemini/skills/docs-writer/SKILL.md b/.gemini/skills/docs-writer/SKILL.md index 13fc91765e..01cb380f7c 100644 --- a/.gemini/skills/docs-writer/SKILL.md +++ b/.gemini/skills/docs-writer/SKILL.md @@ -45,6 +45,10 @@ Write precisely to ensure your instructions are unambiguous. specific verbs. - **Examples:** Use meaningful names in examples; avoid placeholders like "foo" or "bar." +- **Quota and limit terminology:** For any content involving resource capacity + or using the word "quota" or "limit", strictly adhere to the guidelines in + the `quota-limit-style-guide.md` resource file. Generally, Use "quota" for the + administrative bucket and "limit" for the numerical ceiling. ### Formatting and syntax Apply consistent formatting to make documentation visually organized and diff --git a/.gemini/skills/docs-writer/quota-limit-style-guide.md b/.gemini/skills/docs-writer/quota-limit-style-guide.md new file mode 100644 index 0000000000..fe18832465 --- /dev/null +++ b/.gemini/skills/docs-writer/quota-limit-style-guide.md @@ -0,0 +1,45 @@ +# Style Guide: Quota vs. Limit + +This guide defines the usage of "quota," "limit," and related terms in user-facing interfaces. + +## TL;DR + +- **`quota`**: The administrative "bucket." Use for settings, billing, and requesting increases. (e.g., "Adjust your storage **quota**.") +- **`limit`**: The real-time numerical "ceiling." Use for error messages when a user is blocked. (e.g., "You've reached your request **limit**.") +- **When blocked, combine them:** Explain the **limit** that was hit and the **quota** that is the remedy. (e.g., "You've reached the request **limit** for your developer **quota**.") +- **Related terms:** Use `usage` for consumption tracking, `restriction` for fixed rules, and `reset` for when a limit refreshes. + +--- + +## Detailed Guidelines + +### Definitions + +- **Quota is the "what":** It identifies the category of resource being managed (e.g., storage quota, GPU quota, request/prompt quota). +- **Limit is the "how much":** It defines the numerical boundary. + +Use **quota** when referring to the administrative concept or the request for more. Use **limit** when discussing the specific point of exhaustion. + +### When to use "quota" + +Use this term for **account management, billing, and settings.** It describes the entitlement the user has purchased or been assigned. + +**Examples:** +- **Navigation label:** Quota and usage +- **Contextual help:** Your **usage quota** is managed by your organization. To request an increase, contact your administrator. + +### When to use "limit" + +Use this term for **real-time feedback, notifications, and error messages.** It identifies the specific wall the user just hit. + +**Examples:** +- **Error message:** You’ve reached the 50-request-per-minute **limit**. +- **Inline warning:** Input exceeds the 32k token **limit**. + +### How to use both together + +When a user is blocked, combine both terms to explain the **event** (limit) and the **remedy** (quota). + +**Example:** +- **Heading:** Daily usage limit reached +- **Body:** You've reached the maximum daily capacity for your developer quota. To continue working today, upgrade your quota.