Skip to content

Instantly share code, notes, and snippets.

@plufz
plufz / language-and-tone.md
Created November 13, 2025 22:32
Language and Tone Guidelines

Language and Tone Guidelines

This document describes the language and tone we use in project documentation.

Core Principles

Be Human, Not Marketing

Documentation should sound like it's written by a developer for developers, not like advertising copy.

Avoid:

  • Marketing buzzwords ("comprehensive", "streamlined", "revolutionary")
########## A
HOMEBREW_MAKE_JOBS=1 brew install -v mod_security 2>&1
==> Downloading https://www.modsecurity.org/tarball/2.7.7/modsecurity-apache_2.7.7.tar.gz
Already downloaded: /Library/Caches/Homebrew/mod_security-2.7.7.tar.gz
==> Verifying mod_security-2.7.7.tar.gz checksum
tar xf /Library/Caches/Homebrew/mod_security-2.7.7.tar.gz
==> ./configure --disable-dependency-tracking --prefix=/usr/local/Cellar/mod_security/2.7.7 --with-pcre=/usr/local --with-apr=/usr/local/Library/ENV/4.3
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes