The proposal to restructure Gutenberg’s developer documentation was discussed a few weeks ago during the weekly JavaScript office hours (rollback to the discussion here, meeting notes here).
We agreed that it makes sense to clearly identify stakeholders and use cases of the documentation before any action is taken.
This information has been collected in this Google Docs document.
The main stakeholders identified are:
- Site developers: people who create WordPress sites with custom themes and plugins.
- Site builders: people who create sites with primarily a page builder, or a theme that includes a page builder.
- Theme Authors: Developers of WordPress themes, hosted on the official theme directory or elsewhere.
- Plugin authors: WordPress plugin developers.
- WordPress Core contributors: People who contribute to the core of WordPress, to Gutenberg, etc…
- Content creators: People who create content on WordPress sites.
For each of these stakeholders, the nature of the expectations are different. Theme developers or contributors to WordPress want to be able to alter the way the block editor works, its structure or presentation; while site builders and content creators expectations will be best met by the user documentation for the block editor.
Next Steps
The major use cases that emerge from all those in the document mentioned above are:
- Update/alter the UI or the structure of the editor and its elements
- Create blocks for the block editor
- Create block patterns
- Programmatically modify or trigger the functioning of the block editor and its elements
The next steps to move forward could be to propose a structure around these major use cases.
You can do this as a comment to this article. This will also be on the agenda for the next JavaScript office hours.