ABP Community Article Guideline ABP Community Article Guideline Mobile

ABP Community Article
Guideline

Here’s a clear and actionable blog guideline tailored for contributors to the ABP Community Articles section. This guideline is written to help authors write content that aligns with the ABP.IO brand, adds real value to the .NET developer community, and improves discoverability through SEO.

Target Audience

Our readers are:

  • .NET developers
  • Technical leads and architects
  • Developers working with microservices, modular monoliths, and enterprise web apps
  • ABP Platform users
Target Audience

Writing Style

Keep your content:

  • Clear & Concise: Use short paragraphs, bullet points, and headings.
  • Code-First: Include code snippets generously with clear explanations.
  • Actionable: Provide value the reader can apply immediately.
  • Conversational, Yet Professional: Write like you’re helping a peer.
Writing Style

Suitable Topics

Here are some content ideas that perform well:

Tutorials & How-Tos

Tutorials & How-Tos

Step-by-step guides using ABP (e.g., “How to Implement Multi-Tenancy in ABP.IO”)

Project Showcases

Project Showcases

Share your ABP-based project story, architecture, and outcomes.

Productivity Tips

Productivity Tips

Developer workflows, tooling tips, or shortcuts with ABP Studio or ABP CLI

Case Studies

Case Studies

Real-world examples of how ABP helped solve business or technical problems.

Migration Guides

Migration Guides

Migrating from legacy .NET codebases to ABP.

Extensions

Custom Modules & Extensions

Share modules you’ve built for ABP.

Best Practices

Best Practices

Code organization, modularity, domain-driven design using ABP.

Structure Template

Here’s a simple structure to follow:

Title

  • Make it clear, keyword-rich, and helpful.
  • ✅ Good: “Using Blob Storage in ABP.IO: A Step-by-Step Guide”
  • ❌ Avoid: “My ABP.IO Blob Journey”

Introduction

  • Briefly explain what the article is about.
  • Mention the value the reader will gain.

Main Content

  • Use headings (H2, H3) to break sections.
  • Explain each step with code and screenshots if possible.
  • Add notes, tips, or gotchas where relevant.

Conclusion

  • Recap what was achieved..
  • Encourage feedback or sharing.
  • Link to related docs or GitHub repos.

Code Snippet Guidelines

  • Use triple backticks (```csharp) and specify the language.
  • Keep snippets short and relevant.
  • Explain each important block.
  • Optional: Link to full repo or GitHub Gist if needed.
Code Snippet Guidelines

SEO Tips

  • Use relevant keywords naturally (e.g., ABP, framework, ABP.IO, .NET Core).
  • Optimize the title and first 100 words.
  • Use alt text for images.
  • Add internal links to docs, related community posts
SEO Tips

Media Assets

  • Include screenshots or diagrams to clarify complex points.
  • Image format: PNG or JPG (compressed, under 1MB ideally).
  • Use captions if necessary.
Media Assets

Submission Process

Submission Process
1

Prepare your article as a Markdown file or Google Doc.

2

Submit your article to ABP Community

3

Email us if you have questions to marketing@volosoft.com or reach out via the community Discord.

Author Promotion

  • Your name and bio will appear in the article.
  • You can link to your portfolio, blog, GitHub, or LinkedIn.
  • Outstanding posts may be promoted on ABP’s X, Discord, and newsletters!
Author Promotion

Final Tips

  • Stick to one main idea per article.
  • Avoid overly promotional language.
  • Always test your code examples.
  • Keep learning and sharing — that’s what the ABP community is about!
Final Tips