Markdown Documentation

Overview

Standards and practices for creating well-formatted, readable documentation using Markdown and GitHub Flavored Markdown (GFM).

Critical Rules -- Writing Integrity

These rules are non-negotiable and override all other instructions.

No AI Slop

• Never fabricate information. If unsure, say so explicitly.
• Never generate filler text, placeholder prose, or generic content to pad length.
• Every sentence must carry meaning. Remove anything that restates the obvious.
• Avoid weasel words: "simply", "just", "easily", "obviously", "of course".
• Avoid hollow qualifiers: "robust", "powerful", "seamless", "cutting-edge", "world-class", "state-of-the-art".
• Do not produce marketing copy disguised as documentation.
• Write for a technical reader who values precision over politeness.