skills.rest
oborchers
oborchersCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

abbreviation-policy

Enforce consistent abbreviation usage across codebases during code review.

28|3|Updated Feb 22, 2026
Search Tags:#code quality#code review#consistency#readability#naming conventions#abbreviations
One-click install
npx skills add https://github.com/oborchers/fractional-cto --skill abbreviation-policy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: abbreviation-policy
Source: https://github.com/oborchers/fractional-cto/tree/main/pedantic-coder/skills/abbreviation-policy
Command: npx skills add https://github.com/oborchers/fractional-cto --skill abbreviation-policy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the common problem of inconsistent and overly abbreviated identifiers in codebases, which hinders readability, maintainability, and onboarding.

Core Features & Use Cases

  • Abbreviation Guidelines: Provides a framework for deciding when abbreviations are acceptable and lists universally understood abbreviations.
  • Consistency Enforcement: Emphasizes the critical rule that chosen forms (abbreviated or full) must be used consistently across the entire codebase.
  • Use Case: When reviewing code, this Skill helps identify and correct instances where msg is used in one file and message in another, or where obscure abbreviations like mgr or svc are used without justification.

Quick Start

Review the provided code snippet for any inconsistent or unapproved abbreviations.

Frequently Asked Questions about abbreviation-policy

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce consistent code naming conventions and stop inconsistent abbreviations across a codebase?▼

To enforce consistent code naming, you apply a strict abbreviation policy that defines universally understood short forms and mandates their consistent use across all files, preventing mixed identifiers like 'msg' and 'message'.

What is the best way to decide if an abbreviation is acceptable during a code review?▼

The best way to decide if an abbreviation is acceptable is to check it against a predefined decision framework and list of universally understood abbreviations, ensuring it does not hinder readability or onboarding.

How do I identify unclear identifiers and non-standard short forms in my code?▼

You identify unclear identifiers by reviewing code snippets to spot obscure abbreviations like 'mgr' or 'svc' that lack justification, correcting them to enhance readability and maintainability.

Why does using mixed naming conventions with abbreviated and full forms cause maintainability issues?▼

Using mixed naming conventions causes maintainability issues because inconsistent and overly abbreviated identifiers hinder readability and make onboarding harder for developers navigating the codebase.

Can I use this abbreviation policy to standardize naming conventions for a large existing codebase?▼

Yes, you can use this policy to standardize naming conventions for a large codebase by correcting instances of non-standard short forms and mandating consistency across the entire project.

Related Skills

Explore More Software Engineering Skills→
frap129frap129
8

naming-cheatsheet

Apply the A/HC/LC pattern to name variables, functions, and classes.

Community
Intermediate
mgd34msumgd34msu
4

naming-conventions

Detect and fix unused variables, single-letter names, and non-standard abbreviations in code.

Community
Intermediate
eliottbusinesseliottbusiness

requesting-code-review

Automate pre-commit code review with static analysis and security scanning.

Community
Advanced
0xharryriddle0xharryriddle
3

coding-guidelines

Define and enforce Rust coding guidelines for style and correctness.

Community
Intermediate