WordPress / developer-blog-content

In this GitHub space, WordPress team coordinates content to be published on the Developer Blog. Discussions and montly meetings (first Thu - 13:00 UTC) in WP Slack #core-dev-blog
https://developer.wordpress.org/news
40 stars 5 forks source link

How WordPress plugin developers can keep their users content #163

Closed bph closed 1 year ago

bph commented 1 year ago

Discussed in https://github.com/WordPress/developer-blog-content/discussions/136

Originally posted by **dartiss** June 23, 2023 This will be a post based on [the talk of the same name from WCEU 2023](https://europe.wordcamp.org/2023/session/10-things-that-all-wordpress-plugin-developers-should-avoid/). However, I will omit most screenshots where specific plugins are used (I don't want to finger point). The 10 items will be... 1. Aggressive Promotion 2. Inconsistent and confusing menus 3. Don’t take over the user process 4. Avoid creating your own UI 5. Lack of data validation 6. Loading unnecessary content 7. Leaving content behind 8. Forgetting Accessibility Standards 9. Ignoring code quality checking 10. Getting lost in your translations
dartiss commented 1 year ago

Potential re-title, "How WordPress plugin developers can keep their users content", or something similar. My SO is a word-smith so may help me wrangle something better. My plan is to switch around the original WCEU content to be more positive.

bph commented 1 year ago

Thank you @dartiss I updated the title of the issue to reflect the new working title.

dartiss commented 1 year ago

Draft is occurring here. I started this before a lot of the previous discussion happened, so don't panic if reading this soon after I write this πŸ˜‰

dartiss commented 1 year ago

Is there a preferred word count for any articles, @bph (in particular a maximum)?

juanmaguitar commented 1 year ago

Draft is occurring here. I started this before a lot of the previous discussion happened, so don't panic if reading this soon after I write this πŸ˜‰

@dartiss could you provide permission to comment in the doc to anyone accessing with the link?

bph commented 1 year ago

Not really. @dartiss Most post have between 1 - 2000 words but there are also post around 800.

dartiss commented 1 year ago

I'll try for the 2000 then πŸ˜†

dartiss commented 1 year ago

@dartiss could you provide permission to comment in the doc to anyone accessing with the link?

Of course - now done

dartiss commented 1 year ago

Apologies - quick follow up question. My word count is at 1300 and I'm not even half way through. Are you happy if it's bigger than 2000 words, or should I look to be trimming it down to fit round-about that figure?

bph commented 1 year ago

Totally ok with a 2000 word count. It just takes a bit longer for reviewers get through πŸ‘πŸ’ͺ

dartiss commented 1 year ago

So, if it ends up as 3000 words, you'd prefer me to trim it down?

bph commented 1 year ago

Well, it's hard to judge without reading it, you can also make it a two-part series. I won't get to reading it until next week, though.

dartiss commented 1 year ago

Okay, well the main core of the article is now written (see the link above - you should all have comment access on it). I need to do a read-through and tidy up but happy for comments in the meantime.

justintadlock commented 1 year ago

On word counts: we don't have any specific rules. I've got a few that are 2,000+ words and at least one that is 3,000+. But I broke my 7,000-word post into a three-part series.

The one thing that I would add is that it's nicer if you can break those longer posts up a bit by adding media, making liberal use of lists and headings, and doing anything you can to avoid walls of text. People tend to scan blog posts a lot, so those things can help hook them in (and hopefully get them to read the full thing).

dartiss commented 1 year ago

Thanks Justin. It's already divided into titled sections but I'll see if I can add any screenshots to use that don't highlight specific plugins.

dartiss commented 1 year ago

Read through, tidied up and added some screenshots. I think it's now ready.

bph commented 1 year ago

@dartiss I added a few comments, mainly about external links and resources we can add to the post, also some reflexive miniscule 'corrections'.

You should have received an invitation to join the WordPress Developer Blog as 'author' via email to your .org associated email address. Once you confirm, you should be able to access the blog via https://developer.wordpress.org/news/wp-admin and when you are ready to add your draft post there.

dartiss commented 1 year ago

I've addressed all your comments, @bph, and have now added this to the blog as a draft.

dartiss commented 1 year ago

2049 words

bph commented 1 year ago

Awesome @dartiss I forgot to mention: Could you please enable the public post preview link and share here?

Screenshot 2023-09-20 at 12 07 17

Then reviewers from the #core-dev-blog channel don't have to login for the second review.

bph commented 1 year ago

I also want to introduce you to our pre-publish and post publish checklist for after second review.

Pre-publishing checklist:

Post-publishing checklist

dartiss commented 1 year ago

Done.

I use that plugin myself for sharing drafts - I've never come across anybody else before that uses it 😊

dartiss commented 1 year ago

I also want to introduce you to our pre-publish and post publish checklist for after second review.

Is this something you want me to do now, as you mention it's "for after second review"?

bph commented 1 year ago

Oh, right, I didn't mean it as 'in sequence'. Figured you want to wait for feedback from the second review to get back into the post again, but you can do as you please, as long as you keep the post in draft, until after the second review. :-)

dartiss commented 1 year ago

I've now done everything on the pre-publishing checklist (no props, though, as nobody else was involved).

bph commented 1 year ago

For reference The props.relevant guideline https://make.wordpress.org/core/handbook/best-practices/post-comment-guidelines/#giving-proper-credit-props

dartiss commented 1 year ago

Published here: https://developer.wordpress.org/news/2023/09/how-wordpress-developers-can-keep-their-users-satisfied/


Social copy:

Learn how WordPress plugin developers can continue to keep their users satisfied, via a number of things that they should make sure we’re doing:

https://developer.wordpress.org/news/2023/09/how-wordpress-developers-can-keep-their-users-satisfied/

sybrew commented 1 year ago

Discussion https://github.com/WordPress/developer-blog-content/discussions/136 is locked and limited to collaborators??

Anyway, I think this issue is a good fit to highlight this.

In https://developer.wordpress.org/news/2023/09/how-wordpress-developers-can-keep-their-users-satisfied/ under the heading "Clean up after yourself" (there's no anchor):

Transients are scheduled to be deleted daily via delete_expired_transients(). What was observed prompting that part of the article claiming otherwise was probably a caching plugin's setting messing things up.

dartiss commented 1 year ago

You're 100% correct - I've just checked and confirmed this. I was involved with a discussion about transient housekeeping a long time ago and thought this was still lacking.

I've updated the article and will add some props to it for your help - thanks @sybrew