A Search Engine for WordPress Documentation?

A few weeks ago I had the opportunity to meet the Nuclia team, and the first thing that crossed my mind was: with this technology we can put order in the WordPress Documentation.

And that’s what I explained to them, something they received willingly because they are open to collaborating with open-source projects, and more considering that they already have a WordPress plugin and that is the tool they usually use as a CMS.

The Search Engine

So, a Search Engine based on Artificial Intelligence (AI) has been created for WordPress Documentation because it can help to improve the search experience for WordPress users and developers. While there is a lot of documentation available for WordPress, it is often scattered across different websites and maintained by different teams. This can make it difficult to find the information you need, especially if you are new to WordPress.

By using AI, the WordPress Documentation Search Engine can provide a more personalized and relevant search experience. It can analyze user behavior and search queries to better understand what users are looking for and provide more accurate results. For example, if a user searches for “how to install a plugin”, the search engine can use AI to understand that the user is likely looking for step-by-step instructions and provide links to relevant documentation.

Another benefit of using AI in the WordPress Documentation Search Engine is that it can help to surface content that may not have been easily discoverable through traditional keyword-based search. AI can analyze the content of documents and provide more accurate and relevant results based on context and meaning.

Organizing the Sources

The first approach to Documentation has been that it had to be organized, at least, into 2 categories or filters.

The first approach is the type of documentation. Here, at first glance, I have come up with the following:

  • HelpHub (End User / Consumer)
  • DevHub (Power User / Developer)
  • Handbook (Community)
  • Team (Internal teams)
  • Reference (Functions and Code)

As a second element when categorizing, we have the “team” that it affects. In this case, the list is longer:

  • Accessibility
  • Blocks
  • CLI
  • Community
  • Core
  • Design
  • Documentation
  • Events
  • Hosting
  • Internationalization (Locale teams)
  • Marketing
  • Meta
  • Mobile
  • Openverse
  • Performance
  • Photos
  • Plugins
  • Polyglots
  • Security
  • Support
  • Test
  • Themes
  • TV

The first Sources batch

The list of sources is almost endless, so you had to start somewhere.

What is certain, for now, is surely excluded, are the support forums because that will require a more advanced classification work, since each locale has its organization. Although it is likely that the English version can be included earlier.

This list has no preference order for the URL / Sources.

SourceCategoryTeam
https://wordpress.org/documentation/helphub
https://developer.wordpress.org/advanced-administration/devhub
https://developer.wordpress.org/reference/reference
https://developer.wordpress.org/coding-standards/devhub
https://developer.wordpress.org/block-editor/devhubblocks
https://developer.wordpress.org/plugins/devhubplugins
https://developer.wordpress.org/themes/devhubthemes
https://developer.wordpress.org/apis/reference
https://developer.wordpress.org/rest-api/reference
https://developer.wordpress.org/cli/commands/referencecli
https://wordpress.org/news/category/development/devhub
https://wordpress.org/news/category/releases/
https://wordpress.org/news/category/community/helphubcommunity
https://wordpress.org/news/category/events/helphubevents
https://wordpress.org/news/podcast/helphubcommunity
https://wordpress.org/news/category/documentation/documentation
https://make.wordpress.org/docs/style-guide/documentation
https://wordpress.org/news/category/design/design
https://wordpress.org/news/category/meta/meta
https://wordpress.org/news/category/testing/test
https://make.wordpress.org/core/handbook/handbookcore
https://make.wordpress.org/core/teamcore
https://make.wordpress.org/design/handbook/handbookdesign
https://make.wordpress.org/mobile/handbook/handbookmobile
https://make.wordpress.org/accessibility/handbook/handbookaccessibility
https://make.wordpress.org/polyglots/handbook/handbookpolyglots
https://make.wordpress.org/support/handbook/handbooksupport
https://make.wordpress.org/themes/handbook/handbookthemes
https://make.wordpress.org/docs/handbook/handbookdocumentation
https://make.wordpress.org/plugins/handbook/handbookplugins
https://make.wordpress.org/community/handbook/community-team/handbookcommunity
https://make.wordpress.org/community/handbook/community-deputy/handbookcommunity
https://make.wordpress.org/community/handbook/meetup-organizer/handbookevents
https://make.wordpress.org/community/handbook/wordcamp-organizer/handbookevents
https://make.wordpress.org/community/handbook/contributor-day/handbookevents
https://make.wordpress.org/community/handbook/kidscamp-organizer/handbookevents
https://make.wordpress.org/community/handbook/virtual-events/handbookevents
https://doaction.org/participants-guide/events
https://wordpressfoundation.orgcommunity
https://make.wordpress.org/meta/handbook/handbookmeta
https://make.wordpress.org/test/handbook/handbooktest
https://make.wordpress.org/tv/handbook/handbooktv
https://make.wordpress.org/cli/handbook/handbookcli
https://make.wordpress.org/marketing/handbook/handbookmarketing
https://make.wordpress.org/hosting/handbook/handbookhosting
https://make.wordpress.org/photos/handbook/handbookphotos
https://make.wordpress.org/openverse/handbook/handbookopenverse
https://openverse.org/search-helphelphubopenverse
https://api.openverse.engineering/v1/referenceopenverse
https://make.wordpress.org/performance/handbook/handbookperformance
https://wptide.org/docs/devhubtide
https://make.wordpress.org/security/teamsecurity
https://make.wordpress.org/project/team
https://make.wordpress.org/design/teamdesign
https://make.wordpress.org/mobile/teammobile
https://make.wordpress.org/accessibility/teamaccessibility
https://make.wordpress.org/polyglots/teampolyglots
https://make.wordpress.org/support/teamsupport
https://make.wordpress.org/docs/teamdocumentation
https://make.wordpress.org/themes/teamthemes
https://make.wordpress.org/plugins/teamplugins
https://make.wordpress.org/community/teamcommunity
https://make.wordpress.org/meta/teammeta
https://make.wordpress.org/training/teamtraining
https://make.wordpress.org/training/handbook/handbooktraining
https://make.wordpress.org/test/teamtest
https://make.wordpress.org/tv/teamtv
https://make.wordpress.org/marketing/teammarketing
https://make.wordpress.org/cli/teamcli
https://make.wordpress.org/hosting/teamhosting
https://make.wordpress.org/tide/teamtide
https://make.wordpress.org/openverse/teamopenverse
https://make.wordpress.org/photos/teamphotos
https://make.wordpress.org/performance/teamperformance
https://wordpress.tv/
https://learn.wordpress.org/courses/
https://learn.wordpress.org/tutorials/
https://learn.wordpress.org/lesson-plans/
https://af.wordpress.org/team/handbook/handbookinternationalization
https://ar.wordpress.org/team/handbook/handbookinternationalization
https://de.wordpress.org/team/handbook/handbookinternationalization
https://en-ca.wordpress.org/team/handbook/handbookinternationalization
https://es-mx.wordpress.org/team/handbook/handbookinternationalization
https://fr.wordpress.org/team/handbook/handbookinternationalization
https://id.wordpress.org/team/handbook/handbookinternationalization
https://it.wordpress.org/team/handbook/handbookinternationalization
https://ja.wordpress.org/team/handbook/handbookinternationalization
https://pt-ao.wordpress.org/team/handbook/handbookinternationalization
https://br.wordpress.org/team/handbook/handbookinternationalization
https://ro.wordpress.org/team/handbook/handbookinternationalization
https://sr.wordpress.org/team/handbook/handbookinternationalization
https://yor.wordpress.org/team/handbook/handbookinternationalization
https://tw.wordpress.org/team/handbook/handbookinternationalization

Now, we need to wait until the big brain processes all the information.

Leave a Comment