Glossary Contribution Guidelines
Learn our exact standards to craft technical definitions that are extremely clear, engaging, and accurate.
#1 The Plain-English Rule
Always assume the reader is a bright college freshman or junior developer. Break down complex jargon, avoid overly dense blocks of academic texts, and explain analogies (e.g. comparing APIs to waiters, containers to modular shipping boxes, etc.). Keeping descriptions simplified yet highly informative is the primary goal.
Avoid overly dense
"APIs represent operational interface boundaries binding sub-modules across structural application layouts."
Write clearly & simply
"An API acts like a waiter in a restaurant: it carries your request to the kitchen and returns with your food."
#2 Concise, Structural Summary
Every term must begin with a concise 1-2 sentence definition (under 150 characters) summarizing exactly *what* the term is, *why* it matters, and *who* uses it. This summary is used for instant preview cards and quick-lookup grids.
Avoid overly dense
"Continuous Integration is a cultural practice that requires developers to commit and perform a set of pipeline validation tests regularly to avoid regression bugs which might occur during major releases..."
Write clearly & simply
"Continuous Integration (CI) is the practice of automating code builds and tests, allowing multiple developers to merge updates safely daily."
#3 Add Complete Examples & Code
Definitions are infinitely better with practical context. If you define a command or configuration term, provide a short 5-10 line code sample, CLI input sequence, or YAML/JSON configuration mapping. Make it functional, minimal, and fully annotated.
Avoid overly dense
"Docker is built using virtual layers, which you configure with Dockerfiles that contain standard build parameters."
Write clearly & simply
"Provide a minimal 5-line Dockerfile showcasing base image selection, workdir copy, and startup commands."
Ready to Submit your Definition?
Join our writing cohort of 120+ cloud engineers. All approved terminology definitions earn profile level XP and custom contributor badges.