How to write a good post

[camilo_lemos]

Before we go into this subject: first, and absolutely foremost: always search before posting your question. Your question may have already been posted and answered in the forum. Searching can help you save loads of time and effort!

Ok, with that out of the way, let’s go: Writing a good post

Let’s say you come to the forums because you need help with an error. Logically, a good title for your post would be “Help with an error”, right? Well…wrong!

Put yourself in the shoes of the person browsing our forums looking for an issue they can help solve. Does “Help with error” tell them anything about what the actual issue is? Will they click on your post and read it if the post just below yours on the list of topics has a clearer title?

Here are a few tips on how you can write posts which will get you faster and better answers:

• Post title: use only terms that are relevant to the issue or question you have. Avoid commonplace words for a support forum such as “help”, “please”, “urgent”, “hello” – they say nothing about what your issue is. Save these terms for the actual body of your post

  • A good template for an issue is “This happens when I do that”
    • Bad title: “Hello. I need help with an error”
    • Good title: “Error XYZ123 when launching the app”
  • A good template for a question is “How do I…?”
    • Bad title: “A question about workflows”
    • Good title: “How do I export a workflow to…”

• Post body: here is where you should say hello, be friendly, for sure😊 Describe the issue in more detail. Make sure you mention:

  • The version of the Analytics Platform you are using
  • What you are trying to do
  • What is preventing you from achieving it
  • What you have already tried to do to solve this issue (very important!!!)
  • You can use this as a template:
    • “Hello Community! I’m using version 4.5.2, trying to do ABC but I keep running into problem XYZ. I’ve already tried clicking on these buttons, I’ve tried dragging these components, but the problem persists. Here is an image of what I see. Thank you!”

• Resources: the more information you can provide, the better! Think of adding:

  • Reproducible workflow examples (more info here)
  • Sample data
  • Images that illustrate the problem or question

• General Tips

  • Keep it short. Most of our super helpful members are other KNIME users who help others in their spare time.
  • Break up your text into paragraphs; nobody likes reading a 10-line wall of text
  • Add tags using the optional tags field when writing your post– especially when reporting bugs!!