✍ How to contribute an article for Knowledge Base

Knowledge base
1

Before you start

Prerequisite: In order to create and publish an article, you need to be a registered Tech Community member (Software AG Tech Community & Forums - Discover webMethods, Cumulocity IoT, Adabas & Natural resources and experts)

This document helps to identify the right topics and things you should consider when writing an article for Tech Community Knowledge Base. Step by step instructions on how to create and submit and article are available here.

Pick a relevant topic

Here are some questions that could help you identify the right topic.
  • What is relevant for our customer base (common topics/issues our users/developers face)?
    • How to use a specific product/feature, best practices, migration guides, use cases etc.
  • What is relevant in the market in general (use cases, methodologies, architectures, etc.)?
    • AI, Microservices, Security, DevOps etc.
  • How tools you built, can help other developers?
    • E.g. Creating a remote monitoring application using Python

Pick the right title for your article

Help readers understand what your article is about by selecting a short and compelling title. Think about what users could be searching for in search engines when looking to solve a particular problem or extend their knowledge. Create a short and compelling title that will help readers easily recognize the value of your article. (How to.., What is…, xy tutorial, learn…,problem statement)

Structure your content

The right structure and formatting improves the readability of your content. Here is a sample structure we recommend:

  • Introduction: 1-2 sentences, what is the value of the content, why should someone read it
  • Body: Use headings (H2 and H3), paragraphs, lists and images to better structure your content
    • If you use images in your article, please provide appropriate file names (avoid img.jpg and use iPaaS_workflow_designer.jpg instead)
  • Conclusion : Add a short and clear takeaway to your article as a conclusion and don’t forget to also add a call to action (CTA) where possible: e.g test our free trial, watch demo video, etc.
  • Use this guide to see how to format posts and articles: ✍ How to create new posts or articles and format them correctly
  • Example: webMethods.io Integration tutorial - Understanding webMethods.io Integration

Got questions or feedback?
Post under Feedback & ideas - Software AG Tech Community & Forums or send us a message to communities@softwareag.com

Save a draft and collaborate with colleagues before publishing

Check the guide :writing_hand: Shared Drafts: Collaborate on posts before publishing

Why I can’t find my draft under :writing_hand: Shared Drafts ?

While you are writing a post a draft is saved even if you don’t save it under Saved drafts or publish it. You can find these drafts under https://tech.forums.softwareag.com/my/activity/drafts