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

Welcome to the official home of the WordPress Documentation Team.

This team is responsible for coordinating all documentation initiatives around WordPress, including the handbooks and other general wordsmithing across the WordPress project.

Want to get involved?

Start here to find out more about what we do and how to contribute:

Onboarding to Documentation Team: An overview of what we do and how to collaborate
Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHub GitHub is a website that offers online implementation of git repositories that 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/

Weekly meetings

Join our discussions of documentation issues here on the blog and on Slack.

The documentation team holds weekly office hours and monthly Contributor Days on each Tuesday of the month in the #docs 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/. channel. It’s also where you can contact the team at any time outside meetings.

shubhampalriwala 12:59 pm on May 13, 2020

Hi, I am Shubham Palriwala and would like to apply as a Technical Writer.
The Project #2 i.e. Most Popular Security Attacks is what am looking at,
and i was wondering if we could cover the major security attacks categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. wise,
For example: a sub section for an e-commerce websites we can add 3-4 vulnerabilities that are found in most of other ecom websites.
Then a sub section for a different category such as a Forum.
This might help the user prevent the most common attacks in ‘their’ specific category.
- suyashsingh234 5:04 pm on May 13, 2020
  
  Hello, I am Suyash Singh
  I am interested in 4)”WordPress Development Configuration Guide”
  
  My rough proposal->
  
  Before gsod period begins-
  Learn and use all configurations and learn their use cases
  Roughly document steps along the way
  
  During gsod period-
  Make a new site where there are expanding bars for each topic. Something like this “https://open.berkeley.edu/guides/site-builders-guide/edit-html-page/expandcollapse-content”
  
  People can find everything on one site and do not have to visit new sites until unless necessary
Will Kelly 10:28 pm on May 19, 2020

Hi! My name is Will Kelly. I’m a technical writer who is potentially interested in participating in Google Season of Docs this year. Throughout my career as a contract and staff technical writer, I’ve helped organizations create style guides that meet their requirements.

My work writing for publications and commercial, public sector, and non-governmental organizations gives me a holistic view over style guide creation. I’ve authored style guides from scratch and worked with organizations to help them standardize on industry style guides to meet their requirements.

I would love to learn more about what you what like to see in a proposal to improve your style guide.

Sincerely:

Will Kelly
- Jon (Kenshino) 4:05 pm on June 21, 2020
  I think we basically need to run a project where we first evaluate what we need in a style guide, determine the gaps between what we have and what we want to get to.
  
  Next steps will need to be discussed.
  
  I see this starting off with a discovery phase before we setup an action plan.
  
  And the action plan can include others beyond the GSoC participants
  
  I think for a proposal, I’d love to see an approach that tackles
  - The Discovery Phase
  - The Definition Phase
  - The Implementation Phase
  - The Maintenance Phase
smrititiwari 10:18 am on June 12, 2020

Hi! My Name is Smriti Tiwari. I am very much interested in project 3 under the guidance of @kenshino. From what I could understand the project is related to creating a unified tracking system and to create a process to utilize the system.

I have few doubts.
1. Is this tracking system related with marking if a document needs update or is outdated ?
2. Also there are free 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. document tracking systems can we use them ?

I would appreciate if you can give me more idea as to what you are looking for in the project.
Anticipating a positive response.
- Jon (Kenshino) 4:08 pm on June 21, 2020
  
  1. Yes 🙂 Or it could also simply mark that a documentation page is missing information entirely and requires someone to write it up
  2. We could certainly look into it.
  
  I’ve seen success with any tool we use if we continued having consistent people driving the use of such tools
  
  Example, when I was launching the Theme Development Handbook, I took over a 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. with information and filled in the gaps. Unfortunately, once the initial team disbanded, the system wasn’t kept up with. Now it’s tough to figure out whether we lack critical info in that handbook.
manthanadmane 11:56 am on June 16, 2020

Hey team 🙂
My name is Manthan Admane and I would be applying as a technical writer for Google Season of Docs 2020.

I have been attending all Monday meets and have taken up the Code 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 Embed task. I was also fortunate enough to be a part of WCEU 2020 which was a great camp and great experience.

I plan to work on- ‘Improve Existing Development Documentation and Handbooks’ and would wish to base my exploration and proposal phase building around this project, so any suggestions on these lines would be appreciated 🙂

Any other suggestions or specific guidelines for the GSoD proposal will really be appreciated.

The community feels really warm and welcoming : )
- Jon (Kenshino) 4:09 pm on June 21, 2020
  
  I have answered you in another thread

Want to get involved?

Weekly meetings

What’s next?

Share this: