Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 980 Bytes

AGENTS.md

File metadata and controls

15 lines (12 loc) · 980 Bytes

Writing

Use ASD-STE100 Simplified Technical English (STE) in documentation. Check all proposed and edited text for STE compliance before you present or save it.

  • Use "you" to address the reader when appropriate. Prefer active voice.
  • Write procedural steps as complete sentences with periods.
  • Use bold for exact UI text, such as labels, buttons, menu items, tabs, and options. Do not use bold for general emphasis.
  • Do not use italics for UI text.
  • Use backticks for technical identifiers, commands, paths, and text that the user must enter. Use backticks for values that are not UI text.
  • Use the <Screenshot> component for screenshots.
  • Prefer internal documentation links when a relevant page exists.
  • Refer to docs.moodle.org as "the Moodle documentation."
  • If an expandable category links to a content page, show that page as an item in the category. This rule does not apply when the linked page is a category index.

Never try to build the site yourself.