menu SkyTowner Docs
Thanks for the thanks!
close
SkyTowner
DOCS
flagGetting started editWriting guidelines privacy_tipTerms of Service
Editor
boltShortcuts view_in_arComponents
Help
Join Discord emailContact editStart writing

Writing Guidelines

General writing conventions

  • Prefer bulleting over long paragraphs.
  • A good rule of thumb is to adopt the SEE principle:
    • State: what exactly are you trying to achieve?
    • Example: what are some simple examples?
    • Explain: what are you trying to do in these examples?
  • Accompany each code block with a clear explanation.
  • Decompose your articles into sections using hierarchical headings (H1, H2, H3 and H4)