Software Engineering in WordPress, PHP, and Backend Development

Tag: WordPress (Page 191 of 218)

Articles, tips, and resources for WordPress-based development.

How To Document WordPress Projects

Earlier this week, I wrote about the challenges of documenting WordPress projects regardless of if they are free or premium.

In the post, I mentioned that another challenge that comes with actually documenting a project is making sure that you’re catering to the various ways that people learn.

First, as a general rule, I think that projects should include:

  • Source Code Documentation. Free projects should have code comments, premium projects should have code comments, PHPDoc (or similar) style documentation, and API documentation if one is available.
  • A Manual. Free projects should have a README and potentially a web page, premium projets should have a manual that’s perhaps its own website complete with screenshots and/or videos.

But this raises a second question about WordPress documentation, specifically around premium projects: If people have different styles of learning, that is, some learn better by reading, others better by watching, are we obligated to provide both forms of documentation?

Continue reading

WordPress Documentation For Free and Premium Projects

If you spend time maintaining a WordPress project – be it a theme, plugin, or application, and regardless of if it’s free or premium – then you know the challenges that come with writing and maintaining documentation for your project.

Sure, I think many of us who build and maintain projects consider documentation a form of support, but when you ask a customer to define support, you’re more likely to hear about their ability to communicate with someone through a forum or a phone call (depending on your service).

I mean, case in point, when I think about support for my cellular service, I don’t think of documentation of Sprint’s network. I think of talking to a person.

Anyway, all that to say is that over the past few years of working with various types of projects – both on my own and with my team – the trend seems to be that documentation for free projects is expected, but ignored, whereas documentation for premium projects is not only expected, but also read.

But I write this to ask if this is something the rest of you guys have noticed, and, if so, if there isn’t something that can be done to improve this particular situation or it’s simply the nature of the economy. Continue reading

Handling The Fragmentation of WordPress Versions, Themes, and Plugins

For the past few weeks, I’ve been talking about the decision to migrate away from the WordPress Plugins Repository and move back to the premium model similar to what I once offered. The truth is, this is going to introduce a bit of WordPress fragmentation which may not be a good thing.

If you’re just catching up on this, here are a few articles about the migration:

I’ve enjoyed the discussion around all of this, but there’s one problem that is introduced when developers opt to move away from the central WordPress repository.

It introduces fragmentation into the market.

Continue reading

What’s The Proper Way To Instantiate a WordPress Plugin?

When it comes to plugin development – be it either widgets or plugins – there are several different ways in which we can instantiate a WordPress plugin.

Unfortunately, you’re likely to get a different answer depending on who you ask, or what you read.

Case in point: According to the WordPress Codex, instantiating a WordPress widget is done like this:

add_action( 'widgets_init', create_function( '', 'register_widget( "foo_widget" );' ) );

But I know several people who are adamantly against using create_function.

Though I personally don’t have a problem with it, I’m always interested in hearing others’ approach to how they do it and why.

So in this post, I thought I’d lay out the various ways to instantiate a WordPress plugin, pros and cons of each, but also ask each of you what your favorite method is and why.

Continue reading

Offering WordPress Support on Twitter? No Thanks.

Last week, I shared my problems with the WordPress plugins repository. Above all else, I’ve really enjoyed the comments that people have shared – it’s full of good ideas, I’ve had my opinions changed a bit from the initial post, and the conversation is generally respectful.

For those who have been following along, you know that all of this is being shared as I’m slowly working towards the process of restructuring how I build, maintain, and support my plugins.

As such, I’m trying to be as open as I possibly can be about what I like, what I dislike, and what I’m planning to do as this particular restructuring comes into fruition.

One of the things that’s becoming common among businesses – especially larger businesses – is to offer support via Twitter. The more I’ve begun thinking about how to offer support, the more I’m deciding against offering WordPress support on Twitter.

Continue reading

« Older posts Newer posts »

© 2024 Tom McFarlin

Theme by Anders NorenUp ↑