Inclusive Language Guidelines for tldr Pages: Complete Writing Standards

The tldr-pages project mandates imperative mood verbs, gender-neutral terminology, and the complete elimination of personal pronouns across all documentation, as codified in contributing-guides/style-guide.md.

The tldr-pages repository maintains strict inclusive language guidelines to ensure command-line documentation remains accessible, neutral, and welcoming for users regardless of background or native language. These standards are enforced through automated linting and manual review processes that reference specific sections of the project's style guide.

Imperative Mood Requirements

According to contributing-guides/style-guide.md (lines 71-74), every example description must begin with an imperative verb. This rule creates a consistent, action-oriented tone that eliminates subjective or narrative phrasing.

Use imperative commands such as List, Show, Create, or Delete. Do not use third-person singular verbs (Lists, Shows) or second-person constructions (You can list).

# Incorrect

- Lists all running processes.
- You can display system information.

# Correct

- List all running processes.
- Display system information.

Prohibition of Personal Pronouns

The style guide explicitly forbids addressing the reader directly. Lines 669-682 of contributing-guides/style-guide.md mandate the removal of personal pronouns (you, your, yours) to prevent assumptions about the reader's identity or environment.

Replace possessive constructions with direct object references. Instead of writing Copy your file, write Copy the file.

# Incorrect

- Copy your file to your home directory.
- You should restart the service.

# Correct

- Copy the file to the home directory.
- Restart the service.

Gender-Neutral Terminology

Inclusive language standards require gender-neutral nouns throughout all pages. Lines 669-682 prohibit gendered terms such as him, her, man-page, or mankind. Use neutral alternatives like user, developer, or the manual page.

# Incorrect

- The user should set his PATH variable.
- Read the man-page for details.

# Correct

- Set the PATH variable.
- Read the manual page for details.

Translation and Localization Standards

When translating pages, inclusive language rules extend to preserving technical clarity. Lines 887-904 of contributing-guides/style-guide.md specify that brand names, command names, and technical terms must remain untranslated across all locales to maintain consistency.

Placeholders must use culturally neutral formats. Use generic path syntax like {{path/to/file}} rather than culturally specific examples like {{my_resume.docx}} or user-specific directories like {{/home/john/}}.

# Incorrect (Spanish translation)

- Copia {{mi_curriculum.docx}} a {{/home/juan/}}.

# Correct (Spanish translation)  

- Copia {{ruta/al/archivo}} a {{ruta/al/destino}}.

Automated Enforcement

The project validates inclusive language compliance through tldr-lint. This tool checks for imperative mood violations and personal pronoun usage during continuous integration, ensuring all contributions align with lines 71-74 and 669-682 before merging.

# Install and run the linter locally

npm install -g tldr-lint
tldrlint pages/common/tar.md

Summary

• Imperative mood is mandatory: All descriptions must start with a base verb like List or Create, never Lists or You can list.
• Remove personal pronouns: Never use you, your, or possessive constructions; reference objects directly.
• Use gender-neutral language: Avoid gendered terms; use neutral nouns like user or developer.
• Preserve untranslated terms: Keep command names, brands, and technical identifiers in their original language across translations.
• Neutralize placeholders: Use generic path formats ({{path/to/file}}) instead of culturally specific filenames.

Frequently Asked Questions

Why does tldr-pages prohibit the word "you"?

Directly addressing the reader assumes a specific context and can reduce accessibility for non-native speakers or diverse user environments. The style guide mandates neutral phrasing to ensure documentation feels universally applicable, as specified in lines 669-682 of the style guide.

How do I format examples to meet inclusive language standards?

Begin every description with an imperative verb (List, Show, Delete). Remove all second-person pronouns and replace them with direct objects. Use gender-neutral placeholders such as {{path/to/file}} rather than culturally specific filenames or home directories.

Are inclusive language rules different for translations?

While the core requirements for imperative mood and neutrality apply globally, lines 887-904 provide language-specific grammatical conventions for over fifty locales. Translators must maintain inclusive principles while adapting to target-language grammar rules, keeping technical terms untranslated.

What happens if my contribution violates the inclusive language guidelines?

The tldr-lint tool automatically flags non-imperative verbs and personal pronouns during continuous integration. Reviewers will request modifications to align with lines 71-74 and 669-682 of the style guide before merging contributions into the main branch.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}