md-style
Installation
SKILL.md
README Style Guide
Write concise, direct README files for experienced engineers.
Principles
- No fluff - Skip tables of contents, verbose explanations, development history
- No roadmaps - Document current state only, not plans or decisions. Readme is an engineering specification. Not a project plan or changelog.
- No repetition - Each fact appears once
- No hype - Avoid "next generation", "production ready", "powerful", "comprehensive" and similar hyperbole
- Direct voice - State facts, not opinions
- No contrasting embellishments - Avoid like "not just a thing, it's a better thing", "not only a thing, it's something", "more than a"
Structure
Sections in order: Overview, Prerequisites, Usage, Architecture, Configuration, Testing, File Structure. One-line purpose statement at top under H1.