Season of Docs 2020 Projects Move Forward

Google recently announced that two of our Season of Docs 2020 projects are moving forward:

  • Documentation Style Guide proposed by Jon Ang (@kenshino)
  • Improving Article Discovery proposed by Estela Rueda (@estelaris)

These were two of nine possible Docs team projects proposed to GSOD technical writers for vetting.

We arrive at this happy moment after four months of ongoing process and collaboration. Considering there were 49 other organizations participating in Google Season of Docs 2020, it’s a credit to our community effort to bring dedicated technical writers to both projects.

Docs team contributor Atharva Dhekne (@tacitonic) is the technical writer for the Documentation Style Guide project. Milana Cap (@milana_cap) and Felipe Elia (@felipeelia) will be the project mentors.

For Improving Article Discovery, we welcome Diana Mivelli (@dmivelli) as the project’s technical writer. Project author Estela Rueda and (author of this post) Tim O’Haver (@timohaver) will be the project mentors.

Near term, the Season of Docs timeline allows for our writers to get acclimated. By middle September, Atharva and Diana will be fully engaged in their documentation work through November.

#season-of-docs

Join Google’s Season Of Docs: Help Us Create Better Documentation for WordPress

Are you an experienced writer? If you are familiar with writing docs and tutorials for WordPress and want to contribute in Open SourceOpen Source Open Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL., we have few amazing projects under Google’s Season Of Docs 2020, and the sweet part if you are accepted, you can get paid for it!

Season of Docs 2020 - WordPress
Season of Docs 2020 – WordPress

This year we have submitted a number of project ideas to be considered at Season of Docs, you could see we got accepted.

If you look at timeline, you will see we are in the final phase of “Technical writer applications“, deadline July 9, 2020 at 18:00 UTC.

I am personally mentoring for a project I proposed (look at the Project Five on the Idea List Docs), Curate Existing HelpHub Article To Create Pillar Contents, I am writing this post to guide prospective technical Writers to access the project properly, communicate with the mentor, and successfully submit the proposal in time.

I will compile the rest of the post as a resource, will mainly focus on my project, but it should be useable for other projects as well, just communicate with your mentor before you proceed. Remember here Mentor plays an important role if you look at this doc that describes the Mentor’s responsibilities you will realize.

Basics You Need to Know About Season of Docs

Prepare To Apply As Technical Writer

Must-Have Qualities for Technical Writer

I will rewrite this portion from official review criteria, as that’s how we will review the application when Google forward your proposal to us.

  1. Prior Experience: For most of the project pas experience is important, and if you do not have past experience as a writer, you will mostly like won’t be a good fit. At the same time as this is a Technical Writing project, you need to be very aware how that particular technology works, for WordPress nothing is complex, and very well documented already, but as an example, if you are working with docs related to our new BlockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. Editor, but have not explored that deeply, it will be very hard for you to complete the project.
  2. Language & Communication Skills: Though it’s not must that English is your first language, but as we will be doing everything in English, your command over English is very important. So, we will want to see evidence that shows your English skill and overall Communication Skills.
  3. Content & Doc Design: This is very important. Content style and design of the doc is very important if you look at the projects ideas, it’s more about how different mentors are planning to organize the future of documentation approach for WordPress, so any applicant needs to understand the format, style, and design of the doc of that particular projects.

Special Requirement for my Project

Let me copy the project details again here –

==================================================

Project Five: @asif2bd

Project Name: Curate Existing HelpHub Article To Create Pillar Contents
Description
: We are continuously creating more content in HelpHub, but basic questions like “Locally Host WordPress” or “How To Secure WordPress”, are answered with separate CPT and not one article to answer completely or links to existing content. While the current configuration is good for SEO, it is confusing for our users.
Related material:

  • Link to the open source project that needs documentation: https://wordpress.org/support/
  • I am proposing ‘Pillar Content” that will be curated collection of existing content that will direct guide users in finding more authenticated information. Like “How To Secure WordPress” will give precise guideline and will link and resources from following contents

Include links to similar documentation in other projects:

===========================================================

If you have read all the above carefully, then you should realize the requirements for my project. Discuss with me if you need clarification, so you get more clarity before you proceed to the final proposal. This is not an official requirement, but if you submit this before submitting the final proposal, you will have a clear idea, how I will review your proposal in the final stage, as I probably can’t take more than 2-3 writers here, and I am already getting a hand full of the proposal, and this is not a very simple content plan, I need expert hands to truly help WordPress Documentation.

And I would expect about 10Hrs/Week commitment for the duration of the project.

I will try to give feedback via slackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. 24hr, just knock me in Making WordPress slack (@asif2bd).

After you successfully submit the proposal, Google will send it to us, we will review it based on those guidelines.

Let’s flourish with Season of Docs, and improve WordPress Documentation!

#season-of-docs

Season of Docs: Technical Writer Exploration, May 11-June 8

It is with excitement that WordPress is officially participating in Google’s Season of Docs 2020.

From May 11-June 8, technical writers are welcome to review the proposed list of project ideas and ask questions related to proposal development. Mentors, thank you for being on hand to help think through project proposals related to our initial ideas or ones the writers may devise. Technical writer applications are due July 9th; We look forward to working with you!

What’s next?

Technical writers interested in working on one of our project ideas, please add your questions as a comment to this post.

#season-of-docs

Season of Docs Project List Idea

Below is a list of projects that are put forward for technical writing collaboration in this year’s Season of Docs.

As of a reminder of who is involved:

Projects

Project One: @kenshino

Project name: A full and renewed set of documentation style guide
Description:
We’ve written some style guides along the way but many of those applied to specific handbooks or projects we worked on.

That said, there is not a unified style guide nor is it actually complete.

We propose developing a new style guide while fixing up older ones or simply adopt a great existing one with compatible licenses.

Related material:

Project Two: @makewebbetter

Project Name: Most Popular Security Attacks

Description: There are plenty of security breaches issues reported. We plan to create documentation of some of the most common issues with suggested fixes so that users can learn and solve their issues.

Related material:

  • Link to the open sourceOpen Source Open Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL. project that needs documentation – https://wordpress.org/support/article
  • Update existing documentation – https://wordpress.org/support/article/brute-force-attacks/
  • We can have documentation with two to three attacks issues, explain what effect they have on websites, how to prevent, and the fastest way to fix and protect your website.

Project Three: @kenshino

Project name: Tracking Doc Suggestions / Updates
Description: We do not have a unified tracking system for when a doc needs updates. People do it on MetaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. (which is really for code changes to WordPress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/), report them on SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/., and sometimes via Twitter. It’s impossible for people to know if a doc is going through updates or is simply outdated. Some projects use TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. for short term purposes. Some projects use GitHubGitHub GitHub is a website that offers online implementation of git repositories that can can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/.

We really ought to have a unified tracking system so that we can track these requests and the work to fulfill such requests. And we need to create a process to utilize this system properly.

Related material: 
None at the moment. It’s new!

Project Four: @johnzenith

Project Name: WordPress Development Configuration Guide

Description: Code misconfiguration and setup can introduce security bridges and break security endpoints, thereby leaving the door open for malware infections and cryptographic attacks.
Creating a configuration guide or overview for developing in WordPress will be very useful. Some of these exist but are not organized or put together in a single place. For example, the configuration Guide will have several sections as files and directories, debugging, nonces, database, WordPress salt, constants, queries, global vars, htaccess, password, httpsHTTPS HTTPS is an acronym for Hyper Text Transfer Protocol Secure. HTTPS is the secure version of HTTP, the protocol over which data is sent between your browser and the website that you are connected to. The 'S' at the end of HTTPS stands for 'Secure'. It means all communications between your browser and the website are encrypted. This is especially helpful for protecting sensitive data like banking information., etc.

Related Material

Project Five: @asif2bd

Project Name: Curate Existing HelpHub Article To Create Pillar Contents
Description
: We are continuously creating more content in HelpHub, but basic questions like “Locally Host WordPress” or “How To Secure WordPress”, are answered with separate CPT and not one article to answer completely or links to existing content. While the current configuration is good for SEO, it is confusing for our users.
Related material:

  • Link to the open source project that needs documentation: https://wordpress.org/support/
  • I am proposing ‘Pillar Content” that will be curated collection of existing content that will direct guide users in finding more authenticated information. Like “How To Secure WordPress” will give precise guideline and will link and resources from following contents

Include links to similar documentation in other projects:

Project Six: @kenshino

Project name: Improve Existing Development Documentation and Handbooks
Description:
 We have a lot of developer documentation. CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress.’s documentation is mostly automated.

However handbooks that describe how one would create a theme, make a pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party, use the REST APIREST API The REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/. or automate things via the CLICLI Command Line Interface. Terminal (Bash) in Mac, Command Prompt in Windows, or WP-CLI for WordPress. do not receive updated documentation. In turn, this requires that all handbook maintainers know all the changes in each core release to be able to write something useful.

In some cases, the handbooks are updated but don’t provide enough examples for new developers to get started. We would like to close these gaps.

Related material:

Project Seven: @estelaris

Project Name: Improving article discoverability

Description: During the design process, it was discovered that categories are not used to classify documentation articles and an article may have more than two categories instead of using tags to related articles. This makes it difficult for users to search, as they can click on a categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. > article, and hit the return button only to find themselves in an entirely different category. Another issue is the titles which in some cases do not properly describe what the article is about.

Related material:

Project Eight: @milana_cap

Project Name: Extending Block Editor

Description: Documentation on developing on top of Block Editor is, depending on the topic, either scarce, outdated, or non-existent. Considering that Block Editor is a significant language leap for WordPress developers, I think the project itself would benefit from having detailed documentation in a form of guides or tutorials, on how to utilize and extend core functionality and what the best practices are.

Related material:

  • Link to the open source project that needs documentation – https://developer.wordpress.org/block-editor/
  • Updates to an existing documentation set – https://developer.wordpress.org/block-editor/tutorials/
  • Features that need documenting: creating custom blocks (basic webpack setup, what plugins are used and why), using editor’s components in custom blocks, using core blocks in custom blocks, using data stores, using all the hooksHooks In WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same., block settings, plugin sidebars, RichText format types etc. Really, everything.
  • Link to similar documentation in other projects – https://www.gatsbyjs.org/tutorial/

Project Nine: @marcio-zebedeu

Project Name: Write your first WordPress Theme

Description:
It is not enough to say that creating a WordPress theme is easy if we do not show it in practice in the documentation. Currently we have a good article on how to start with WordPress, I believe we could do more to make the theme development manual better, as it does not provide a kind of tutorial that really ends with the creation of a functional theme.

  • Related Material:
  • Link to the open source project that needs documentation: https://wordpress.org/support/article
  • Updates to existing documentation:
  • https://developer.wordpress.org/themes/getting-started
  • It can be divided into stages: Creating a htmlHTML HTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites. template, adding simple styles, separating those from html files and finally converting to one of the templates for the WordPress theme

#season-of-docs

Season of Docs: A Call For Projects!

Thank you to all who responded to @kenshino initial call for mentors as we prepare to participate in this year’s Season of Docs. As this season’s primary administrator, I am looking forward to working with you all!

Mentors

For those listed below, please be sure to familiarize yourself with the responsibilities of being a mentor and apply before the deadline of May 4th 20:00 UTC. If you have any questions, @kenshino will be acting as a support throughout the mentoring process.

Next Step: Project Ideas List

Our next step is to create a project ideas list. This list should include documentation projects that would benefit from the work of a technical writer. Each of these projects will need the guidance of two mentors. Please add your project ideas as a comment below by Thursday, April 30th UTC 11:59.

#season-of-docs

We’re applying to Season of Docs

What is it?

The goal of Season of Docs is to provide a framework for technical writers and open sourceOpen Source Open Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL. projects to work together towards the common goal of improving an open source project’s documentation.

This is a Google Initiative

What does it mean for us?

During the program, technical writers spend a few months working closely with an open source community. They bring their technical writing expertise to the project’s documentation, and at the same time learn about the open source project and new technologies.

We’ll likely get professional documentation people who can help us put WordPress documentation into shape!

Who’s involved?

  • Chloé Bringmann, @cbringmann (Primary Administrator)
  • Andrea Middleton, @andreamiddleton (Backup Administrator)
  • Jon Ang, @kenshino (Docs Team)
  • Adam Silverstein, @adamsilverstein (Support from Google)
  • Mentors (from the Docs Team)
  • Tech Writers (people that apply to help us!)

What do we need now?

The program requires two key things to get started

  • Mentors
  • Projects

For now, we’re looking to get a group of mentors together who’s well acquainted or want to be well acquainted with WordPress’ Documentation needs and projects.

If you’re interested to be a mentor, please comment below. We’ll leave this open for a week so that we can get a team together to suggest projects and work through the application.

The initiative is a lot more than I’m describing so feel free to read more at the Season of Docs site!

#season-of-docs