Skip to content

Template Language Guide

Ion Y edited this page Jan 22, 2022 · 1 revision

Copy this template when setting up a guide for a programming language.

{Language} Guide

- Coding Convention
- Documentation Standard
- Library and toolchain recommendations

Use these categories for items in the guide:

  • Requirements are policies that must be followed unless there is good reason not to
  • Recommendations are best practices to follow and worst practices to avoid, but they have room for interpretation and developer judgment.
  • Rationales are explanations

Requirements and recommendations should be short, clear, and RFC-2119 friendly. Rationales can be more details should be visually distinct from requirements and recommendations. Indentation works, as do links to other parts of the document.