Search results

WordPress and web CMSs

Series: Trends to follow or forget

by Tom Johnson on Feb 27, 2022
categories: technical-writing

This post is part of a series that explores tech comm trends that I've either followed or forgotten, and why. The overall goal is to better understand the reasons that drive trend adoption or abandonment in my personal career. This post focuses on WordPress and web content management systems (CMSs).

WordPress and web CMSs

WordPress started out as a popular blogging platform but has since evolved into a multipurpose online platform with an extensive library of plugins that makes it easy for non-technical people to create rich, interactive websites for almost any need. WordPress is so popular that, as of 2021 it powers approximately 37% of the total websites on the web! WordPress falls within a category of online web content management systems (CMSs) similar to Drupal and Joomla, which are also popular.

Why I embraced WordPress and web CMSs

WordPress gave me the tools I needed to launch my blogging presence online. My timeline started in 2006, when I volunteered to be the “webmaster” (remember that term?) for the STC Suncoast chapter (which has since combined with Orlando as STC Florida). As the new web manager, I wanted to redo the website, so I poked around on the available tools on the web host panel and found an easy path with WordPress.

My efforts at managing the STC Suncoast site soon spawned my own blog, and later I become adept enough at WordPress that I managed a side hustle as a freelance WordPress consultant for about 5 years (often working on the Lavacon.org site) to supplement my day job as a technical writer.

I loved how WordPress made it easy for people without deep technical skills to create and manage websites. The web leveled the playing field, allowing anyone to write and publish content. But tools like WordPress made it technically possible for people to actually manage content online in a way that looked professional, with the functionality they needed through an extensive library of plugins.

For years, I longed to merge the toolset used in my day job as a technical writer (at the time, HATs) with my post-work hobby as a blogger (using WordPress). However, while WordPress worked great for publishing web content, its PHP code made it a difficult sell for enterprises, which typically forbid PHP due to security vulnerabilities. In fact, troubleshooting hacked WordPress sites was a common task in my freelance consulting.

Besides PHP, WordPress also required other infrastructure that was hard to set up without more engineering support, such as a MySQL database. Many web hosts (like Bluehost) provided this infrastructure in a way that was already configured and optimized for WordPress, so you didn’t have to worry about things like whether you had Apache web server or other components in the LAMP stack correctly configured.

But this wasn’t the case within the enterprise. In the enterprise, you didn’t simply get FTP credentials and a web panel to manage a site. You might get a bare-bones Linux box, if they give you anything at all. You usually would need engineering-level access to hit a production server as well. And engineering groups would rarely grant production server access to technical writers.

In sum, security practices made WordPress almost an impossible option in the enterprise. For many years, I thought about how great it would be to finally get the opportunity to use WordPress for docs, and I waited patiently for the right enterprise conditions to experiment.

I finally got my chance to play in the web CMS space when I joined a startup (Badgeville, focused on gamification — both of which fizzled) that was using Drupal as the main content platform for documentation, support forums, and marketing content &mash; all living together on one site under the same federated search.

Drupal agencies were fairly common, and we hired an external agency to customize some API documentation templates in Drupal. All we had to do is upload some JSON files and populate other fields in a structured template to publish API docs that looked pretty amazing, I have to say.

However, despite the ease of these templates, Drupal was a bit clunky for editing. I usually wrote content in Google Docs, managed the review process there, and then converted the content to HTML to paste into the Drupal editor (bypassing their WYSIWYG editor).

Why I abandoned WordPress/Drupal and web CMSs

I left the Badgeville startup after just one year due to company instability issues. The hiring and firing in that place was so volatile, with a new CEO every six months rebalancing everything, that I’d become concerned (being the main breadwinner for my family and living in the one of the most expensive places on earth — SF Bay) about being “next.” As a result, I transitioned to another company (41st Parameter / Experian). With that transition, I left Drupal behind.

However, my fantasy of using WordPress (or similar, like Drupal) for docs had met a reality check with Drupal. Documentation scenarios presented many challenges that weren’t common with more mainstream online publishing needs handled by web CMSs. For example, content re-use, variables, translation workflows, versioning, access gateways, review workflows, and more all become problematic with a web CMS.

Further, doing simple operations like global find-and-replace was challenging. To do a find-and-replace in Drupal, it involved a database query that could very easily go wrong (with unsupported characters ending up in the output). You also couldn’t easily move pages around or rename them. And editing became much slower.

In fact, years later when I started working for Amazon, the team I joined was using a web CMS as well (a Java-based web CMS called [Hippo CMS, which was later rebranded to Bloomreach). It was also a nightmare to work in that web CMS as well for similar reasons. One of my first tasks was to help us migrate off of that platform.

Despite the problems of web CMSs, engineers liked these solutions for writers because they enabled us to push content into production environments through a simple, controlled interface. These tools enabled an easy way to publish content externally, without going through official engineering releases, but the authoring experience was poor. WordPress excelled for me as a blogger because so much of the content development workflow involved one-off blog posts — articles that I wrote once and never returned to. But tech docs was a different affair — you managed a set of documentation overtime, constantly editing existing content. You might change a product name across 20 different pages, or add an include for a note or warning on the same pages.

Because the authoring experience was so bad in these web CMS systems, I actually started using OxygenXML and DITA to create and manage content outside of Drupal. In fact, DITA started to appeal to me because it offered solutions for all the tech comm scenarios I was up against (unlike WordPress, which required me to find my own hacks). I longed to merge the worlds of DITA and web-based CMSs. I wrote a whole series of posts on this topic:

In the end, my experiments with DITA and Drupal ended when I left the Badgeville startup and joined another company that was using a different system for docs (first Confluence, and then Jekyll). I also abandoned WordPress for my personal blog about this same time as well (circa 2015) so that I could better unify the authoring/publishing systems in my professional and personal worlds. If I was using Jekyll to publish docs at work, I also wanted to use Jekyll to publish my blog at home.

Current status

WordPress still continues strong for the variety of websites that make up the web, but I don’t come across too many WordPress-based documentation sites. Of course, it’s not always clear what technologies are used in building websites (Wappalyzer is a tool that performs a tech probe query on any site you view), but my sense is that tech writers are often burdened by requirements that WordPress never evolved to cover.

As soon as you have to produce PDFs, send docs out for translation, provide multiple versions, re-use content, implement variables, control access to some content, make content available offline, etc., using these web CMS platforms becomes strenuous. Additionally, companies usually restrict the technologies that these systems require (e.g., PHP). As a result, WordPress never seemed to take off as a common documentation platform, despite powering so many sites on the web.

The failure of WordPress to excel as a tech comm tool reinforced the fact that technical writers face unique requirements for content authoring and publishing. This puts them at a disadvantage because they can’t easily piggyback on mainstream content publishing tools but instead must rely on more of a niche category of specialized tools from a subset of vendors.

Takeaway

Even the most popular web platforms of the internet might never find relevance within the enterprise nor be the tool of choice for documentation scenarios (for which they weren’t designed).

Next post

Continue to the next post in this series: DITA.

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.