skilld
All skills
google-gemini avatar

/docs-writer

@220888a
by google-geminigoogle-gemini/gemini-cli107k stars
14,675

Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.

Ask your Agent

Use this Skill: https://skilld.dev/gh/google-gemini/gemini-cli/docs-writer

This session only. Nothing lands on disk.

quota-limit-style-guide.md

≈530 tokens on demand. Your agent reads this file only when SKILL.md points to it.

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.

Source: SKILL.md on GitHub

Third-party checks

1 warning16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    This skill provides comprehensive guidelines for technical writing and auditing within the Gemini CLI project. It includes standard development procedures such as repository file access and the use of package managers for code formatting. Users should be aware that processing untrusted documentation files carries a minor risk of indirect prompt injection, typical for agents that interact with external content.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer6mo

    2 files scanned · No issues

  • ZeroLeaks5mo

    1 finding · Score: 69/100

Provenance

Signed by skilld at 220888a. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 1 hour ago.

Activeupdated 6 months ago

Topics

README badge

README badge for google-gemini/gemini-cli/docs-writer

What it does

Guides Claude in writing, editing, and reviewing documentation for the Gemini CLI project while adhering to specific standards for voice, grammar, formatting, and structure. Use this skill when modifying any `.md` files or content in the `/docs` directory.

Generated from the current SKILL.md.

Frequently asked

Does this skill work with non-Markdown documentation formats?
The skill is designed for Markdown files in the `/docs` directory and `.md` files elsewhere in the repository. It includes specific guidance for `.mdx` files but does not cover other documentation formats.
What happens if I need to update documentation that references a changed heading?
The skill requires you to check for deep links to that heading in other pages and update them accordingly before finalizing changes.
Does this skill enforce a specific documentation style?
Yes. The skill enforces the Gemini CLI project's standards, including active voice, present tense, US English, the serial comma, and specific formatting rules for callouts, lists, and links. It also requires adherence to a quota-limit style guide for resource-related content.
Can I use abbreviations like 'e.g.' and 'i.e.' in documentation?
No. The skill requires you to avoid Latin abbreviations and use full phrases instead: 'for example' instead of 'e.g.' and 'that is' instead of 'i.e.'.
What should I do if a documentation request is ambiguous?
You should ask for clarification to understand whether the request involves writing new content, editing existing content, or auditing the documentation before proceeding.

Generated from the current SKILL.md. These answers refresh after source changes.