Skip to content

Content Guidelines for Hyperswitch Articles

Jump to bottom
GORAKHNATH YADAV edited this page Sep 27, 2024 · 3 revisions

Content Guidelines

  • Structure

    • Feel free to add to the structure already provided in the issue.

    • Introduction: Small buildup to the topic.

    • Scope: Define the length and breadth of the topic covered by the article.

    • Takeaways: Summarize the main points and takeaways from the article.

    • Summary: Briefly summarize the content covered in the article.

  • Comprehension

    • Simplicity: Check if a sentence or idea can be communicated in a simpler way.

    • Flow: Maintain cohesion throughout the article.

    • Objective: Use ordered or unordered lists where necessary, and avoid large chunks of text.

  • Engaging

    • Narration: Keep the narration fun, easy, and informal, unlike textbooks, unless a formal tone is intended.

    • Analogies / Examples: Provide relatable examples or analogies for abstract concepts.

    • Statistics: Back claims with statistics and numbers from reliable sources, and mention them too.

  • Correctness

    • Technical Accuracy: Mandatory.

    • Grammatical Accuracy: Preferred, otherwise be prepared for backlash.

  • Visual Illustrations

    • Please try to accommodate images, diagrams, illustrations to better communicate the content. We recommend using tools like Excalidraw/Google Drawing.

Prompt best practices  

In today’s world, it’s hard to restrict AI tool usage, but we expect contributors to bring unique insights from deep research, like long reports and videos that AI can't fully capture. For best AI assistance, use the recommended prompt practices, and only submit a PR if you've truly enriched the content beyond what AI tools will generate.

  • Avoid any ambiguity in the topic.

  • Specify important keywords related to the topics to be used in the article.

  • Define the audience and their intention to read it.

  • Specify the structure and format(word limit and important sections).

  • Specify the Tone to be used in the article.

  • Include any references for the content.

  • Use clear feedback for iterative improvement on following prompts.

SEO Guidelines

  • Please keep the content about payment orchestration in general from a learning perspective.

  • Word limit - ~1500+ words (Feel free to go beyond this limit, if needed).

  • Ensure that the plagiarism of the final content is below 7%.


Bonus Tip - You can find most interesting facts/nuisances in tech blogs written by payment domain experts in platforms like Medium, Dev.to etc.

Clone this wiki locally