Writing

On this page

Write for contributors from different fields and language backgrounds. Use selected principles from Simplified Technical English. OSRI does not claim full STE conformance.

Write clearly#

  • Use familiar words, direct verbs, and consistent technical terms.
  • Keep paragraphs short. Give one action per instruction.
  • Aim for 20 words or fewer per instruction sentence and 25 per descriptive sentence. Keep the meaning when shortening a sentence.
  • Define technical terms and abbreviations on first use.
  • Cut repetition, hype, idioms, and filler.
  • Use descriptive links and sentence case for headings.

Preserve meaning#

  • Keep scientific qualifications, uncertainty, conditions, and negation.
  • Preserve quotations, source titles, identifiers, code, equations, and units.
  • Use must for requirements, should for recommendations, and may for permission.
  • Link claims to sources or results. State the actual review and publication status.
  • Follow venue requirements for manuscripts.

Use shared names#

  • Open Source Research Initiative (OSRI): introduce the full name in standalone documents.
  • Agentic-Powered-Research: preserve this spelling. People choose questions, direct work, assess evidence, and authorize publication.

English fluency is not required to participate. Maintainers help contributors prepare clear text.

View source on GitHub