• Content Management in WordPress (@markel) (deleted for brevity)
• What is a Theme? (@hanni)

Part One: Theme Basics

• Including CSS stylesheets and scripts (@drewapicture)
• Template Tags
• The Loop (@markel)
• Theme Files and Organization (@siobhan)
• Custom Page Templates (@maria@woothemes.com)
• Template Hierarchy
• Theme Functions (@siobhan)

Part Two: Theme Functionality

• Accessibility
• Comments (@sewmyheadon)
• Media
• Navigation Menus (@ryanr14)
• Pagination
• Post Thumbnails (@ryanr14) (@ryanr14)
• Sidebars (@ryanr14)
• Translation (@jerrysarcastic)
• widgets http://codex.wordpress.org/Widgetizing_Themes – move to plugin dev handbook
• Next and Previous Links http://codex.wordpress.org/Next_and_Previous_Links (markel)
• Linking Theme Files and Directories /Determining_Plugin_and_Content_Directories
• Custom Headers /Custom_Headers
• Adding Admin Menus http://codex.wordpress.org/Adding_Administration_Menus

Part Three: Advanced Theme Topics

• Child Themes
• Theme Customizer [This still needs to be properly incorporated: http://codex.wordpress.org/Theme_Customization_API ]
• Theme Security
• Creating an Admin Theme http://codex.wordpress.org/Creating_Admin_Themes
• UI Best Practices
• Theme Unit Tests http://codex.wordpress.org/Theme_Unit_Test
• Validating Your Website http://codex.wordpress.org/Validating_a_Website

Part Four: Theme Release

• Required Template Files
• Submission Process (this will be included in Theme Review Guidelines page)
• Testing
• Theme Review Guidelines
• Writing Documentation http://codex.wordpress.org/Theme_Review#Theme_Documentation

Jerry, Ryan, Mike, and Maria – feel free to add any of your own suggestions in the comments.

Indexing support forums

A lot of our support traffic is from Google, so people are searching for issues and then landing on the support forums. However, they are often landing on results that are completely out of date. For example, if you search for “WordPress permalinks not working” there are search results from three years ago and fix years ago. If you search for “WordPress 403 forbidden” pulls up results from 4 years ago. Should we prevent Google from crawling forums results over a certain age in order to help these searchers more easily find the content that they need?

Stack Exchange

How can we better support the work that goes on over on WordPress Stack Exchange? Should we get the moderators there more involved with the Support/Docs team? Should be look at ways that we can direct our more technical users & developers to Stack Exchange which they might find more suited to their needs?

User Advocacy

Should we have people on the support team act as user advocates and be more actively involved with WordPress development? WordPress is a user-focused product but there is little interaction between the development process and the support team. User advocates could act as a bridge between the developers and users. They could have responsibility for opening tickets based on feedback in the support forums, attend development meetings to raise questions from the perspective of users, and generally get involved with core.

Best Practices for Plugins

Mozilla has Project Squeaky to improve user experience for add-ons. They actively work with developers to ensure that users have a good experience. Many issues with WordPress come from third-party plugins – is there a way that we can help developers make plugins better? Some suggestions are best practices for plugin developers, a better plugin developer handbook, code templates that people can use for their plugins.

Better Integration Between Support Methods

Can we improve integration between the support forums and documentation? Could we suggest documentation pages based on the question that someone asks? Can we use apps like text expander or Alfred to create responses with links, best practice, and good suggestions, that forum moderators can use to help them deal more efficiently with support requests?

Analytics and Optimization

We should do some advanced analytics to find out what users are doing with documentation, how they’re finding it, what they’re clicking on. It would also be useful to do some user testings for common things that users are doing with WordPress: for example, finding and installing a WordPress theme, searching for plugins on the internet, finding documentation. Our users aren’t only users while they’re in the WP admin or even WordPress.org. What are they doing on Google? Where are they going for support? User testing can also be carried out to see how effective our documentation is.

Support for different versions of WordPress

There is a lot of information in the Codex relating to different versions of WordPress – some go back as early as WordPress 1.5. It makes no sense to have these in the Codex any more. We should also adjust the terminology for user documentation when new features are introduced the Codex says things like “Post formats is a theme feature since version 3.1“. While this is appropriate for API documentation, it makes no sense for user docs. Our documentation should reflect the current version of WordPress only.

Notes:

• Solving the Q&A conundrum with Stack Exchange
• How Mozilla helps users all over the world
• Listening to your audience
• Drupal for Technical Communication
• Wikipedia: Too much documentation
• Docs Sprints, Docs Sprints, Liberathons

Just some practical information, including the agenda and schedule.

What you will need

• your laptop
• a local install or other test site
• an IRC client (we’ll all be logged in to #wordpress-sfd)
• please familiarise yourself with the style and formatting guide
• your brain

Food & Social Activities

We’re having our docs dinner together on Monday night at a restaurant near the hotel.

Tuesday night we can figure out what to do while we’re there.

Lunch isn’t provided by the venue but I’m told that there are lots of places around that we can get food. I’ll buy some munchies ahead of time.

Workshop

It’s the first time we’ve gotten together in person so I think doing a workshop will be a good idea. We’ll look at the frustrations around WordPress documentation and review the results of the recent Codex survey and Codex audit. After discussion we should have a list of tasks for improving WordPress documentation and a roadmap for ongoing improvements. We will also define our goals for the following 2.5 days and create teams to work on specific tasks.

Note: one of the summit action items was to create a Codex Roadmap – it would be great if we could produce this at the sprint.

Here’s the agenda. Note that it’s fairly fluid – I just wanted some sort of structure for the three days. I’ve added a few presentations which I will give on the first day on doc writing. I’ve also contact a few of the other attendees about doing short presentations. If anyone else would like to do one please feel free to – just keep it to 10-15 minutes.

Agenda

17th June 2013

9:00 – 12:00 Documentation Workshop

12:00 – 1:00 Lunch

1:00 – 1:15 – presentation from Siobhan about planning docs

1:15 – 2:30 Planning

In the teams, work on planning out the documentation that you’re going to create.

2:30 – 3:00 Break

3:20 – 3:30 presentation from Siobhan about writing docs

3:30 – 5:30 Writing!

5:30 – 5:45 Stand-up to review what we’ve done for the day

7pm – Dinner at Nada

18th June

9:30 – 9:45 Morning standup

9:45 – 1:00 Writing

1:00 – 2:00 Lunch

2:00 – 6:00

6:00 – 6:15pm Evening standup

19th June

9:30 – 9:45 Morning standup

9:45 – 1:00 Writing

1:00 – 1:30 Lunch

1:30 – 3:30 Writing

3:30 – 16:30 Wrap up and task list for future

17:00 – I’m off to the airport!

• Drew – Advanced Users
• Eric – WP Builder & novice dev
• Siobhan – Intermediate dev
• Jerry – WP User

Please post your results here by Friday 14th June. We’ll be using the results along with other research that’s been going on to do a workshop on the first morning of the docs sprint.

A few notes for the reviewers:

• Use the filter at the top to filter by your assigned user group I’ve edited your access so you just get the results for the user group you’re looking at.
• Remember that if a respondent provides a particularly insightful answer you can click on the report number to the left of their answer and read through that person’s individual report.

If there’s any other questions you feel should be added to the report, let me know in the comments.

Outline for Report

User Type:

Learning preferences (please list in descending order, noting the percentage):

Notable answers listed under other:

Top three places to look for an answer to a question (list in descending order, noting the percentage):

Are there any other places that these users are regularly looking for answers (make sure you check through the “Option option” answers)?

How useful is the Codex to this user group?

What sections of the Codex do these users find most useful?

What are the main problems these users face with the Codex?

What documentation would these users like to see more of?

Based on your review of this survey, do you have any general observations about how this user group is making use of the Codex and documentation more generally?

Based on your review of the survey, what recommendations would you make specifically about the WordPress Codex that would help these users?

Based on your review of this survey, make three recommendations for improved documentation that would serve these users:

Contributing to WordPress Docs

What percentage of these users have contributed to WordPress Docs?

What percentage are aware that they can use their WordPress.org login to edit the Codex?

How can we make it easier for these users to contribute to WordPress docs?

In light of that, I’ve opened a ticket to get some callout boxes created for the handbooks. It’s be fantastic if someone could put some styles together.

That’s:

• 6pm Amsterdam
• 5pm London
• 12 Noon Eastern
• 11am Central
• 10 am Mountain Time
• 9am Pacific

The content we analysed broke down broadly into these different areas:

User

• Installing WordPress
• Getting Started
• Glossary
• Blogging
• Site Builder
• Troubleshooting
• Multisite
• Administration (inc Security?)
• Getting Help

There are also about 60 reference pages for the various Panels/Screens. e.g. http://codex.wordpress.org/Administration_Panels

Developer

• Setting up a Development Environment
• How WordPress Works
• Troubleshooting
• Code Reference
• Plugin Developer
• Theme Developer
• Server
• Multisite
• Administration

I am keen to have a strict division between the user-focused material and the developer-focused material. Of course, there are times when a developer will be a user (when they are managing their website) and there are times when a user will be a developer (when they tweak their theme) but linking between resources is more effective than putting the user and developer material together.

I’m reluctant to make major plans for restructuring and changing everything around before we close the Codex survey and analyse the results (some of which are surprising i.e. not everyone hates the Codex), however, I would like to come up with some concrete tasks for the Docs Sprint in a few weeks.

Therefore, I suggest that the team at the docs sprint tackle the following handbooks that can be built on learn.wordpress.org:

• Site Builder Handbook
• Blogging Handbook
• Editor Handbook
• Theme Developer Handbook

Thoughts? Complaints? Suggestions?

Pages

(needed in time for release):

• Post Formats [ current ][ new draft ] Ref: #19570 (original), #24046 (redesign)
• Revision Management [ current ][ new draft ] Ref: #23497 (mostly technical)
• Menus Administration Screen [ current ] Ref: #23607 (Tracking ticket)
• Menus User Guide [ current ] Ref: #23607 (Tracking ticket)
• Post Locking [ new ] Ref: This is more of a UX change. Users now have to consciously override the post lock, vs before you could just open something if somebody was editing it.

(anytime)

General

Version 3.6

• Version 3.6 page http://codex.wordpress.org/Version_3.6
• 3.6 Changelog http://codex.wordpress.org/Changelog/3.6

Post Formats

• Pages (above)
• New functions (below)

Twenty Thirteen

• Update Using Themes to reference Twenty Thirteen and Twenty Twelve
• Twenty Thirteen only for 3.6+ (add to glossary description)
• Add Twenty Thirteen examples to Child Themes article (Twenty Thirteen = blog, Twenty Twelve = blog/cms)
• Add Twenty Thirteen references alongside Twenty Twelve on Common WordPress Errors article
• Replace Twenty Eleven w/ Twenty Thirteen in Updating WordPress article
• Update reference in Multisite Network Administration article
• Add Twenty Thirteen reference alongside Twenty Twelve in First Steps with WordPress article
• Add reference to Appearance Menus Screen article
• Add reference to Appearance Header Screen article
• Add reference to Login Trouble article

oEmbeds

• Rdio.com oEmbed support added (@Ipstenu)
• Spotify oEmbed support added
• PollDaddy oEmbed support (maybe) re-added #24395

Media

• Add list of default allowed mime types to get_allowed_mime_types()
• Add .webm (video/webm) to allowed mime types list

Developers

‘needs-codex’ Trac tickets

>> Look for the Trac comment where needs-codex was added for more info

• #11446 – Show ellipsis after truncated filename in Media dialog
• #13578 – wp_link_pages isn’t fully functional and doesn’t include require style information
• #15081 – Search Form should use type=’search’
• #15155 – Allow filtering of shortcode attributes
• #16738 – Add filter for attributes on menu item links
• #17515 – Flaw in add_meta_box/do_meta_boxes
• #19067 – Duplicate functionality in core: size_format() and wp_convert_bytes_to_hr()
• #19210 – Add missing filters to remaining link(url) functions in feed.php
• #19321 – get_search_form() function calls an action and a filter with the same hook.
• #19570 – Post Formats: admin UI + fallbacks for themes that don’t support them
• #20564 – Framework for storing revisions of Post Meta
• #22187 – Add docblocks to wp-signup.php
• #22885 – Correct the PHPDOC for the_post_thumbnail
• #22905 – PHPDoc refresh for register_sidebar()
• #22913 – “Files “”corrupted”" when streamed to file via HTTP API”
• #22960 – Add functions to extract images from content, attached to post, , or arbitrary string
• #23058 – Corrected inline docs for cache.php
• #23119 – UX Improvements to nav-menus.php
• #23121 – Correct inline doc return value for WP_Filesystem_Base::gethchmod
• #23313 – inline doc additions in wp-includes/formatting.php
• #23325 – wp_crop_image does not return WP_Error when save fails
• #23508 – Nav Menu Saving: get_nav_menu_locations() can return false, code expects array
• #23570 – Add functions to extract a URL from an arbitrary string, HTML, or the current $post
• #23572 – Add functions to parse Audio / Video data out of arbitrary content or a post
• #23625 – Add function to extract or parse chat as structured data
• #23641 – Tweaks to menu management box
• #23770 – Restore ‘Locations’ meta box functionality as secondary tab in Menus UI
• #23791 – Missing @param in wp_get_attachment_image() docs
• #23792 – Disallow moving of locked posts to the trash
• #24203 – Remove the_title_attribute() from anchors with the_title() as text
• #24265 – Clean up revision.php docblocks
• #24314 – Documentation Improvement wp_dashboard_quota
• #24343 – Correct inline docs for hook parameters in wp_delete_term()
• #17950 – Introduce wp_registration_url()

New Functions

Post Formats

• the_post_format_url()
• the_post_format_chat()
• the_post_format_video()
• the_post_format_audio()
• the_post_format_image()
• the_post_format_quote()
• the_remaining_content()
• the_post_format_gallery()

• get_post_gallery_images()
• get_the_post_format_url()
• get_the_post_format_chat()
• get_the_post_format_media() (@Hearvox)
• get_the_post_format_image() (@csixty4)
• get_the_post_format_quote()

• post_formats_compat()
• get_post_format_meta()
• get_the_remaining_content()
• post_format_content_class()
• add_chat_detection_format()
• get_post_format_content_class()

Audio / Video

• wp_add_id3_tag_data() (@csixty4)
• wp_read_video_metadata() (@csixty4)
• wp_get_video_extensions() (@Hearvox)
• wp_embed_handler_audio() (@Hearvox)
• wp_video_shortcode() (@Hearvox)
• get_attached_video() (@Hearvox)
• get_content_video() (@Hearvox)
• get_embedded_video() (@Hearvox)

• wp_read_audio_metadata() (@csixty4)
• wp_get_audio_extensions() (@Hearvox)
• wp_embed_handler_video() (@Hearvox)
• wp_audio_shortcode() (@Hearvox)
• get_attached_audio() (@Hearvox)
• get_content_audio() (@Hearvox)
• get_embedded_audio() (@Hearvox)

Media

• wp_mediaelement_fallback() (@Hearvox)
• get_attached_media() (@Hearvox)
• get_content_media() (@Hearvox)
• get_embedded_media() (@Hearvox)
• get_attached_images()
• get_attached_image_srcs()
• get_content_images()
• get_content_image()
• get_content_galleries()
• get_post_galleries()
• get_post_galleries_images()
• get_post_gallery()
• img_html_to_post_id() (@csixty4)
• attachment_url_to_postid()
• get_content_chat()
• get_content_quote()
• get_content_url()
• wp_parse_post_content()

Revisions

• wp_post_revision_title_expanded()
• wp_revisions_enabled()
• wp_revisions_to_keep()
• wp_text_diff_with_count()

General

• wp_nav_menu_disabled_check()
• wp_nav_menu_update_menu_items()
• do_accordion_sections()
• wp_slash()
• wp_unslash()
• wp_is_writable()
• wp_auth_check_load()
• wp_auth_check()
• get_tag_regex()
• wp_registration_url()
• wp_heartbeat_settings()
• paginate_content()
• get_paged_content()
• shortcode_exists() (@mordauk)
• has_shortcode() (@mordauk)
• wp_remove_object_terms() (@DrewAPicture)
• wp_add_object_terms() (@DrewAPicture)

New Filters

• enable_post_format_ui (@blobaugh)
• self_link – [23521] (@blobaugh)
• get_comments_link – [23624] (@blobaugh)
• comments_link_feed – [23624] (@blobaugh)
• comment_link – [23624] (@blobaugh)
• nav_menu_link_attributes – [23565] (@blobaugh)
• wp_revisions_to_keep – [23818] (@blobaugh)
• wp_link_pages – [23653]
• search_form_format – [23798] (@blobaugh)
• user_search_columns – [24056] (@blobaugh)
• wp_http_accept_encoding – [23601] (@blobaugh)
• widget_meta_poweredby – [23424] (@blobaugh)

Deprecated Functions

• wp_convert_bytes_to_string() in favor of size_format() (@DrewAPicture)
• get_user_id_from_string() in favor of get_user_by() (@DrewAPicture)

External Libraries

• Services_JSON 1.0.3
• jQuery Color 2.2.1
• Backbone 1.0.0
• jQuery UI 1.10.3
• Iris 1.0.3
• hoverIntent r7
• MediaElement.js 2.11.1 (New)