0007: Documenting Styleguide Decisions as ADRs

Context

Consistent style and formatting improve readability, give authors a clear framework for producing high‑quality work, and streamline collaboration. Numerous style guides exist for academic papers¹² and technical documents³⁴⁵ for these reasons.

My writing journey is just starting, and my writing style prefrences are changing constantly. It is important for me to document these decisions, as well the motivation and a context behind them.

Decision

Use STYLE_GUIDE.md

Alternatives

From https://sourcegraph.com/search?q=context:global+file:%5ESTYLE%5B_-%5D%3FGUIDE%5C.md%24+&patternType=keyword&sm=0

  26 STYLE-GUIDE.md
  94 STYLEGUIDE.md
 118 STYLE_GUIDE.md
   1 Style-Guide.md
  10 StyleGuide.md
   1 Style_Guide.md
   3 Styleguide.md
 146 style-guide.md
   1 styleGuide.md
   9 style_guide.md
  33 styleguide.md

• CODING_STYLE.md
• CODE_STYLE.md
• WRITING_STYLE.md
• WRITING_GUIDE.md

Consequences

Resources