Skip to content

Write a Blog for your Project

Jump to bottom
Abby Mitchell edited this page May 24, 2023 · 1 revision

Writing a blog about your Qiskit Ecosystem project is a great way to get the word out and attract more users/collaborators. Feel free to use this document as a guide for writing a blog about your project. You don’t have to follow the template exactly, but it should serve as good starting point. You can use this for your own website/blog or reach out to Abby Mitchell via slack (@Abby Mitchell) or email (abby.s.mitchell@ibm.com) if you would like to share your piece on the Qiskit Medium.

Some general writing tips
  • Aim to keep the word count under 1,000 words (readership drops the longer a blog is)
  • Use accessible language. Don't assume that everyone reading your blog will understand the jargon you use, especially if you are talking about particularly technical topics. Try your best to explain things in layman's terms and/or share links to documentation or other resources that could fill in any gaps your reader might have.
  • Include links to jupyter notebooks, open source repositories, documentation, PRs etc. so people can see the code you've developed. If you've developed something new - teach readers how to use it!
  • Include images and code examples to break up long wordy sections and make your blog more engaging (code examples are especially encouraged! 🙌)
  • Avoid going into too much detail on theory and avoid including equations in your post (Medium currently doesn't have great support for equation formatting)
  • If you are stuck for ideas, think about answering the following questions:
    • What are the key features/ideas you have implemented?
    • Why did you make certain design/implementation decision (was it for performance, usability, open source reasons etc.?)
    • Why should your audience be excited about what you've created?
    • How does your project address the needs of users?
    • How can people get started using/learning about your project?
    • How can people get involved and help push your work further?
  • Have fun! This isn't an academic paper or school homework, this is your chance to shout about the fantastic work you've done, and help your audience realise just how awesome it is! 🎉

    • Template

    Blog Title: Introducing: [PROJECT NAME], a Qiskit Ecosystem package for [highlight feature]

    Authors: [names of writers]

    [PROJECT NAME] is a recent addition to the Qiskit Ecosystem [Main/Extensions/Community] Tier! Read on to learn more about this new member of our open-source community and how you can use it in your quantum code!

    What is [PROJECT NAME]?

    In this section give a broad overview of what your project is, we recommend focusing on the following things:

    • top 1-3 features that your project provides
    • why is this valuable to qiskit users?

    Getting Started with [PROJECT NAME]

    In this section we recommend showing people a “hello world” of your project. Provide some simple code examples that people could use to get going straight way with your project.

    Future Work

    If you have any upcoming plans for your project you can tell users about it here. This is also a good point to encourage people to get involved in your open-source project if you are looking for more contributors/collaborators

    This concludes our whistlestop tour of [PROJECT NAME]! If you’re interested in learning more about the project, check out the GitHub/website here [LINK]. This project is part of the [Main/Extensions/Community] Tier of the Qiskit Ecosystem. If you’re interested in learning about other projects in the ecosystem, or want to know how to nominate your own project go to qiskit.org/ecosystem for more information.

    Clone this wiki locally