Skip to content

Latest commit

 

History

History
22 lines (17 loc) · 671 Bytes

writing-an-article.md

File metadata and controls

22 lines (17 loc) · 671 Bytes
name about title labels assignees
Suggest new topic
Suggest a new topic for an article or a tutorial

This is a guide helping you to write an article

Your article should have the following structure:

Structure

  • Title
  • Introduction (briefly explain what people will learn in this article)
  • Goals (explain what does the person "gain" by reading the article/tutorial)
  • Prerequisites (mention the software versions that are required and the necessary knowledge background)
  • Step-by-step instructions (explain how to achieve the above mentioned goal)
  • Provide a link to the source code of your article/tutorial (e.g., github)
  • Conclusion