77 lines
1.7 KiB
YAML
77 lines
1.7 KiB
YAML
# Copenhagen Truck Wash API — Writerside Style Guide
|
|
# This file defines the style rules for our documentation.
|
|
# For more details, see https://vale.sh/docs/topics/styles/#extension-points
|
|
|
|
# --- RULE: Encourage descriptive language (existence) ---
|
|
extends: existence
|
|
message: "Avoid using '%s'. Try to be more descriptive or direct."
|
|
level: warning
|
|
ignorecase: true
|
|
tokens:
|
|
- simply
|
|
- just
|
|
- easy
|
|
- easily
|
|
- simple
|
|
- basically
|
|
- obviously
|
|
- actually
|
|
- very
|
|
- really
|
|
- pretty
|
|
- quite
|
|
- rather
|
|
|
|
---
|
|
# --- RULE: Flag incomplete documentation (existence) ---
|
|
extends: existence
|
|
message: "Incomplete documentation: '%s' found. Please provide comprehensive details."
|
|
level: error
|
|
ignorecase: true
|
|
tokens:
|
|
- TBD
|
|
- TO BE DETERMINED
|
|
- TODO
|
|
- FIXME
|
|
- Placeholder
|
|
- Coming soon
|
|
|
|
---
|
|
# --- RULE: Preferred terminology (substitution) ---
|
|
extends: substitution
|
|
message: "Consider using '%s' instead of its informal or less descriptive counterpart."
|
|
level: suggestion
|
|
ignorecase: true
|
|
swap:
|
|
check[ -]box: checkbox
|
|
right-click menu: context menu|popup menu
|
|
webpage: page
|
|
click on: click|select
|
|
press: press|select
|
|
setup: set up
|
|
log[ -]in: sign in|log in
|
|
e-mail: email
|
|
interface: UI|interface
|
|
the following: :
|
|
utilize: use
|
|
functionality: feature|function
|
|
additional: more|extra
|
|
|
|
---
|
|
# --- RULE: Avoid jargon and filler (existence) ---
|
|
extends: existence
|
|
message: "Avoid jargon or filler phrases like '%s'."
|
|
level: warning
|
|
ignorecase: true
|
|
tokens:
|
|
- leverage
|
|
- bandwidth
|
|
- synergy
|
|
- best-in-class
|
|
- cutting-edge
|
|
- robust
|
|
- state-of-the-art
|
|
- mission-critical
|
|
- go-forward
|
|
- paradigm shift
|