Writing an article
How can i write an article about refine? Where should i post it?
2 Replies
Hi @Emi. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave:
----------------------
To write an article about Refine, you can follow the guidelines provided by the Refine team. Here are the steps and considerations to keep in mind:
Steps to Write an Article
1. Outline Submission:
- Before you start writing, you need to submit an outline of your article. The outline should include:
- Target Audience: Who is your article aimed at?
- Learning Outcomes: What will the reader learn from your article?
- Main Headings/Sections: Include the main headings or sections of the article along with an explanation of what will be taught in each section.
- A good outline helps organize your thoughts and ensures all important points are covered. Once your outline is approved by the editors, you can proceed to write the first draft.
- Source (https://refine.dev/blog/refine-writer-program/#submission-process)
2. Article Structure:
- Introduction: Provide a compelling introduction that motivates the reader to continue reading. Focus on the problem being solved rather than the technology used.
- Prerequisites: List any required development environment setups or concepts that need to be understood before reading the article.
- Main Content: Follow the outline and ensure each section is well-explained and logically connected.
- Conclusion: Summarize what the reader has learned and encourage them to ask questions in the comments.
- Source (https://refine.dev/blog/refine-writer-program/#post-structure)
3. Writing Style:
- Use a formal but friendly tone.
- Avoid jargon, memes, slang, and emojis.
- Use second-person phrases instead of first-person words.
- Avoid words like "simple," "easy," "simply," "obviously."
- Use motivational language, e.g., "In this tutorial, you will install..." instead of "You will learn how to install..."
- Source (https://refine.dev/blog/refine-writer-program/#we-use-motivational-language)
4. Technical Requirements:
- Write the article in markdown format.
- Do not publish the article on platforms like hackmd.io or your personal blog immediately. Wait for at least one month before publishing it on your personal blog for SEO purposes and provide a canonical URL.
- Add the word count at the end of your article, excluding the code.
- Use tools like Grammarly to fix all grammar mistakes and spelling errors.
- Source (https://refine.dev/blog/article-guideline/#inroduction)
5. Project Setup:
- If you need to bootstrap a new project with React or Next.js for the article, use the
create refine-app CLI.
- Example command to create a project:
- Source (https://refine.dev/blog/article-guideline/#project-installation-for-example-app)
6. Visuals:
- Add screenshots and images to show outputs if you are building an example app.
- Ensure your example app outputs look cool and understandable.
- Optimize GIF sizes before adding them to the article using tools like ezgif (https://ezgif.com/optimize).
- Source (https://refine.dev/blog/article-guideline/#screenshots--images)
Where to Post
- Once your article is ready and approved, Refine will promote it on their official dev.to account, LinkedIn, Discord, and Twitter channels.
- You will get a byline with your name and a link so readers can find more about you.
- [Source](https://refine.dev/blog/refine-writer-program
----------------------
Note: you can ask me a follow up question by @ mentioning me again :speech_balloon:
----------------------<@268705889865695234> kapa.ai is still learning and improving, please let us know how it did by reacting below