How to Write a Technical Article for the Duda Community Blog

Sheyla
Sheyla Member, Administrator Posts: 221 mod
edited March 11 in Discussions

How-To Guides are meant to inform the reader of exactly how to accomplish a task or solve a problem within the Duda platform. It should include clear instructions on how the user navigates through the platform and should be easy to scan by using bold font for buttons the user must click and, in some cases, a few images and icons.

To submit a how-to post for consideration, see the following recommendations and a bit about the process.

When you start writing, here are a few things to keep in mind:

  • Explain the use case for the how-to post. What problem will this help the user solve?
  • Steps should be numbered and contain one to two actions per step.
  • Bold the name of buttons the user needs to click.
  • Only use screenshots to clarify complex sections of the UI. If you find yourself needing a screenshot at each step, consider creating a video tutorial instead (link to tutorial kit).
  • Remember to give your how-to post a second (or third) review for mistakes and reference the Microsoft Manual of Style if you need tips on formatting, terminology, or tone.

How Do I Submit a How-To Post?

  1. After drafting your how-to post, send the post to [email protected] with the Subject Line 'Duda Community: Technical Article Submission'.
  2. Our Support team will review your post for accuracy. Note: Our Support team will not provide feedback on why your steps are incorrect or what the correct steps are.
  3. You will receive a reply within 7 days about the status of your submission.
  4. Update any required changes to the how-to post and resubmit to [email protected].
  5. You will receive an email when the how-to post is live in the Duda Community.

Questions? Comment below!

Tagged:

Comments