menu SkyTowner Docs
close
SkyTowner
DOCS
flagGetting started privacy_tipTerms of Service emailContact webBack to dashboard

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)