tutorial-doc-template.md

id
tutorial-doc-template.md

Template for Tutorial Docs (Build a demo/solution with Milvus)

Please describe the demo/solution that you expect to acquaint users with and preparation/prerequisites that involved.

Step 1 - Use second-person imperative to state the operation

Keep the instructions prescriptive. Use a more conversational tone in a tutorial page.

Aim for utility and simplicity when adding code/example  .

Step 2 - Use clear and concise words in title and steps

Users would prefer learning everything they need in a tutorial page, thus try not to use too many hyperlinks in the middle of the page to cite references from other pages. List them at the bottom of the page if necessary.

# Add comment(s) on code when needed
this is code  .

Step 3 - If possible, keep the number of steps less than ten

...