Skip to content

📝 Mini Style Guide

This portfolio follows a simple, consistent writing style.
The goal: clarity, consistency, and easy scanning.

✍️ Writing style

  • Use short, direct sentences (aim for one idea per sentence).
  • Write in the active voice (e.g., Click Save, not The Save button should be clicked).
  • Address the reader with imperatives (“Click…”, “Select…”).
  • Use present tense for steps and descriptions.
  • One action per numbered step.

💻 Formatting rules

  • Headings: Use emojis + plain titles (e.g., ## ⚡ Quick Start).
  • Bold for button names, menu paths, or anything the user must click.
  • Example: Click File → Export**
  • Italics for emphasis or placeholders.
  • Example: Enter your Project name**.
  • Code font for commands, file names, or text to type.
  • Example: Save as glossary.csv.

📷 Screenshots

  • Crop tightly to show only the relevant area.
  • Add alt text for accessibility.
  • Example: ![Trados New Project wizard](trados-new-project.png)
  • Use arrows or boxes sparingly to highlight UI elements.

🔗 Linking

  • Relative links inside the repo (e.g., (quick-start.md) not full URLs).
  • In overviews (README.md), always add a short description after each link.

📅 Maintenance

  • Every doc ends with a Last updated line.
  • Add a short version note if content applies to a specific software release.
  • Example: > 🛈 Written using Trados Studio 2017.

Last updated: 4 Sept 2025