-
-
Notifications
You must be signed in to change notification settings - Fork 70
Home
Martin edited this page Oct 16, 2020
·
8 revisions
If you're familiar with Git and Markdown, please follow our Contribution guide.
You can contribute to Knowledgebase with an article. DX Knowledgebase has two possible types of articles - problems (that you have encountered) and practices (the best method to overcome problems).
- Ask for or propose an article topic via email at dev@dxheroes.io
- Name your article
- Write an article. Feel free to use your favorite text editor.
- Submit your article at dev@dxheroes.io
- Use the active voice when possible
- Establish a clear structure and try to be precise
- Be brief, clear, and direct
- Important information in the main clause
- Simplify your language
- Avoid jargon and abbreviations
- Define acronyms and initialism on their first use - give the abbreviation in parentheses after the full terminology
- Use a grammar check tool, for example:
For Practice:
TL;DR
What Is a %{name}
Why You Might Want the %{name}
Problems the %{name} Helps to Solve
How to Implement the %{name}?
Common Pitfalls of the %{name}
Resources for the %{name}
For Problems:
TL;DR
What Is a %{name}
Reasons for %{name}
Practices solving the %{name}
Resources for %{name}