Skip to content

STYLING.md

Latest commit

 

History

History
102 lines (57 loc) · 1.95 KB

STYLING.md

File metadata and controls

102 lines (57 loc) · 1.95 KB

Styling Guide

Tables

Use tables sparingly. Only for:

  • Small comparison tables (2-4 columns, 10 or fewer rows)
  • Data that benefits from tabular format

Prefer lists for most content. Large tables are hard to read.

Formatting

DO NOT use:

  • Bold formatting (NO **text**)
  • Italic formatting (NO *text*)
  • Horizontal rules (NO ---)
  • ALL CAPS for emphasis

DO use:

  • Code ticks for filenames: jobs/analysis.md
  • Code ticks for code-related terms: jobs, scripts, extract_llm.py
  • Proper list formatting (see below)

Lists

Use blank lines before and after lists.

For simple items:

  • Item one
  • Item two

For numbered sequences:

  1. First step
  2. Second step
  3. Third step

For items with descriptions:

  • Item one - description here
  • Item two - description here

Use - (single dash) for separators within text, not -- (double dash).

For grouped lists with sub-items, use proper nesting:

  • Category name
    • Item one
    • Item two
  • Another category
    • Item three

Links

Links with descriptive text:

Analysis - Main analysis script

For multiple links, format as a list:

Headings

H1 (#) is used once at the top of each document for the title.

H2 (##) is used for main sections.

H3 (###) is used for subsections when it makes logical sense to organize content under a main section.

Numbers

Use percentages with one decimal place for clarity:

  • 69.4% instead of 69%
  • 12.3% instead of 12%

Use raw counts for small numbers, add percentages for context:

  • 621 jobs (69.4%)

Tone

Write in first person ("I") for research findings:

  • "I found 19 roles..." not "The analysis found 19 roles..."
  • "This indicates..." not "This suggests..."

Be direct and concrete. Avoid bureaucratic language.