Skip to main content

Guide writing

Write this guide for people who are busy and may be new to Tiep. Explain each idea in plain, respectful language: simple enough for a child to follow, without talking down to the reader.

  • Start with what the feature is for, then show the smallest useful example.
  • Use short sections with clear names. Define an unfamiliar word the first time it appears.
  • Prefer concrete names and examples over abstract descriptions.
  • Use tables for a small set of options or key/value rules. Use a diagram only when it makes a flow or relationship easier to understand than a short list.
  • State defaults, limits, and security behavior plainly. Keep examples safe to copy and explain what readers must replace.
  • Keep one concept per section and link to deeper pages instead of repeating a long explanation.
  • Before finishing, check that the page answers: what is this, when should I use it, how do I do it, and what happens if something is missing or wrong?