Chloe Bringmann 1:55 pm on May 1, 2020
Tags: season of docs ( 6 )

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:

Chloé Bringmann, @cbringmann (Primary Administrator)
Andrea Middleton, @andreamiddleton (Backup Administrator)
Jon Ang, @kenshino (Docs Team/Mentor Support)
Adam Silverstein, @adamsilverstein (Support from Google)
Maedah Batool, @maedahbatool (Mentor)
Milana Cap, @milana_cap (Mentor)
Estela Rueda, @estelaris (Mentor)
Ahmad Awais, @mrahmadawais (Mentor)
Usman Kahlid, @usmankhalid (Mentor)
John Zenith, @zenithcity (Mentor)
Tim O’Haver, @timohaver (Mentor)
Alain Schlesser, @schlessera (Mentor)
Marcio Zebedeu, @marcio-zebedeu (Mentor)
Felipe Elia, @felipeelia (Mentor)
M Asif Rahman, @asif2bd (Mentor)
MakeWebBetter, @makewebbetter (Mentor)
Shubham Nigam, @iamshubhamnigam (Mentor)

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:

Our current style guide: https://make.wordpress.org/docs/handbook/documentation-team-handbook/
Google’s dev style guidehttps://developers.google.com/style

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 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

Link to the open source project that needs documentation: https://wordpress.org/support/article
Updates to existing documentation: https://wordpress.org/support/article/hardening-wordpress,https://wordpress.org/support/article/changing-file-permissions,
https://wordpress.org/support/article/debugging-in-wordpress, https://wordpress.org/support/category/security
The configuration guide will be broken down into sections that will address specific issues or setup. For existing resources, they can be referenced accordingly. The main idea behind this configuration guide is to organize WordPress configuration settings into a single base.

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:

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 Handbook: https://developer.wordpress.org/block-editor/
Common APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. Handbook: https://developer.wordpress.org/apis/
Themes development handbook: https://developer.wordpress.org/themes/
Plugin development handbook: https://developer.wordpress.org/plugins/
REST API handbook: https://developer.wordpress.org/rest-api/
WP CLI handbook: https://developer.wordpress.org/cli/commands/

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:

List of articles in WordPress.org/documentation, including categories: https://wordpress.org/support/
Work that has been done to recommend different categories/subcategories for articles https://docs.google.com/spreadsheets/d/1_Ea2yeF5Rfy_YDk7pBRJ4rdljhMjygXFqBq8gWwhbaE/edit?usp=sharing
Findings in the reclassification of WordPress.org documentation https://make.wordpress.org/docs/2020/02/21/findings-in-the-reclassification-of-wordpress-org-documentation/
Category term archive https://github.com/WordPress/HelpHub/issues/231
No search results should guide the user to forums https://github.com/WordPress/HelpHub/issues/47

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

suyashsingh234 7:24 am 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
- john zenith 6:55 am on June 29, 2020
  
  Hello and sorry for the late reply.
  
  To make the project development process extremely easy and straight forward, I think we will need a clear and concise road-map of what we want to do with one major goal in mind: organizing WordPress configuration guides into a structured list so that people can locate the resource easily.
  
  Here’s a breakdown of what we can do.
  
  1. Find a suitable location on WordPress where we will organize new and existing configuraton guides into, probably: https://wordpress.org/support/article/configurations/ (has not been created yet)
  2. Use sub-headings and sections to organize the resources on the list. For example, we can have sections like – constants (how to disable file editing, enable debugging mode, etc.), file permissions, administration over ssl, user login and registration, using secure password, roles and privileges (access control), maintenance, reverse proxy and virtual hosts, htaccess (disabling php execution in specific folders, etc.), automatic updates, and so on.
  3. From here, we can start the creation of new configuration guides, add to existing ones, and where possibe, it would be nice if we can include things like best configuration practices to follow as well as, how not to do it (ways configurations should never be done).
  
  Going forward, there are links to existing configuration guides included in the project description above. However, you can correlate those guides with new ones and fix them into sub-configuration sections as you see fit.
  
  If you have more questions, please don’t hesitate to reach out.
  
  Many thanks.
prubhtej 4:11 pm on May 14, 2020

Greetings,
I would like to apply as a contributor in this year’s GSoD.
I would like to choose Project-Six: “Improve Existing Development Documentation and Handbooks”.
A rough estimate from my side would be to study all the forms of documentation that are presently there and try to extract only the useful parts out of them for the next 15 days or so.
Before the GSoD period begins, I would be having a basic idea of what’s there in the documentation and what needs to be updated.
During the GSoD period I’ll be working on the updations as well as the handbooks along with channelizing the information in the documentation and the handbooks.
My main aim would be to provide a lucid as well as fully updated documentation for 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/
Hope to hear from you soon
Regards
Prubhtej Singh
- prubhtej 12:47 pm on June 17, 2020
  
  @kenshino I would be really grateful, if you could please provide some additional details with regards to Project Six, like in which cases, the handbooks are updated but don’t provide enough examples for new developers to get started?
  Also, I have started to draft my proposal and I’ll send it to you for review soon.
  Hope to hear from you soon
- Jon (Kenshino) 3:50 pm on June 21, 2020
  
  Hello and sorry for the late reply.
  
  I think there are 2 big things we can tackle here.
  
  1. Finding the gaps – WordPress is updated regularly, the handbooks aren’t. We have no visibility of whether the handbooks have caught up to the latest WordPress version
  2. Providing good examples – Not all the handbooks have the same number of examples. E.g. I think I’d probably be able to read the Theme Handbook and be able to build a simple theme from scratch. But I might not with 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/. handbook.
  
  Currently, there are the Theme, 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, CLICLI Command Line Interface. Terminal (Bash) in Mac, Command Prompt in Windows, or WP-CLI for WordPress., REST API, 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 and Common Topics development handbooks
  
  I think the best use of your time is to pick a handbook you resonate with the best and work on the 2 big problems above.
  
  Are you a developer or an end-user?
  - prubhtej 1:19 pm on June 22, 2020
    
    Thanks for replying !!
    Basically, I want to contribute as a documentation writer in SoD-2020. If I have any doubts further, I’ll surely ask them.
    - prubhtej 1:36 pm on June 22, 2020
      
      Also, what I would like to propose is, let’s say I start with 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/. handbook by updating the contents and giving it it a unified style thereby combining Project-One & Project-Six. By doing this both the requirements will be fully satisfied, i.e having a unified style guide & simultaneously updating the handbooks.
      I’ll try to update at the least 2 handbooks and as far as, rest of the handbooks are concerned, I’ll try to take them up after the completion of the project. Hence, according to me both of the proposed projects can simultaneously be completed together.
      Hope to hear from you soon.
      - Jon (Kenshino) 3:26 pm on July 1, 2020
        
        Hello @prubhtej that sounds great.
        
        @kadamwhite wonder if you’d be able to consult on this?
        
        prubhtej 5:22 pm on July 1, 2020
        
        Greetings,
        I’m really grateful that you replied. I’ll try to send my proposal to #docs 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/. by tomorrow. Since we have less than a week to go for submissions, I would request you to review my proposal as soon as possible & I hope you’ll like my proposal.
        Regards
maghrabyz 2:26 am on May 16, 2020

My name is Amr Maghraby, I am a new graduate from AAST college got the first rank on my class with CGPA 3.92 and joined the international competition in the US called ROV got the second worldwide and last summer I have involved in Google Summer of code 2019 and did good work also, I participated in problem-solving competitions ACM ACPC and Hash Code. I am interested to participate in the first project “A full and renewed set of documentation style guide”.
Regards,
Amr Maghraby
- Jon (Kenshino) 3:50 pm on June 21, 2020
  
  Hello,
  
  Thank you for your interest!
  
  Do you have a question?
protechthor 5:44 pm on May 18, 2020

Hello everyone and @makewebbetter .
Nice to meet you all.
I’m interested in Project Two: “Most Popular Security Attacks”. I have technical writing experience from a few open-source projects and a personal blog. A while ago, I wrote some articles on cybersecurity. I have built several websites on the WordPress platform and ensured their security. I, therefore, have the relevant knowledge and experience for this project.
I’m hyped to be part of this project. While waiting for the application period, do you have any documentation tasks I could do to get familiar with the docs? In the meantime, I’ll be exploring the docs and looking for any issues to fix.
Regards!
- MakeWebBetter 2:41 am on May 20, 2020
  
  That’s really great @protechthor, I will be in touch with you over 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/..
  - Jon (Kenshino) 3:51 pm on June 21, 2020
    
    @makewebbetter can we make sure any info you’ve provided is also shared publicly for others?
    - MakeWebBetter 5:15 am on June 22, 2020
      
      Ok @kenshino sure I will collect all info and sharing in comments thanks.
dmivelli 11:48 pm on May 19, 2020

Hi all and @estelaris,

I’ve reviewed the proposed WordPress Season of Docs projects. Many piqued my interest but ultimately, I’m most enticed by Project Seven: Improving article discoverability.

Most recently, I’ve written technical documentation for using the Sitecore Experience Platform content management system components for an internal audience of marketers. I’m halfway through a Professional Technical Writing Certificate program through the University of Washington. This quarter’s focus has been on the importance of making every topic a page one topic and this sounds like what Project Seven delves into. I’d love to contribute to this project by sharing my knowledge to help improve the HubHelp categorizations and update the titles so that site users receive the information they seek.

It looks like a lot of investigation has been completed. It would be beneficial to discuss with a mentor/@estelaris a bit more about the vision for working on this project. This would help me solidify ideas to add to the proposal.

I look forward to hearing from you.

Thanks for your time,
Diana Mivelli
- Estela Rueda 3:56 pm on June 21, 2020
  
  Already chatted with Diana 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/.
rapperdinesh 3:53 pm on May 26, 2020

Greetings to all and @marcio-zebedeu

I am Dinesh Bhagat, a Computer Science sophomore at Indian Institute of Technology Mandi. I saw all the project ideas and found interest in Idea 9 : ‘Write your first WordPress Theme’.

I am a blogger and a content writing and had been working on wordpress for two years now. I have developed website for startups using wordpress themes and it would be a good task to frame documentation on Writing your first wordpress theme.
Before the documentation period begins, I will learn and acquire all the pre-required knowledge about the matter by interacting with the mentor,
This will ease my job of documentation during the GSoD period.
I am looking forward to have great learning experience with team and project mentor @marcio-zebedeu.
Please guide me on how to proceed further.

Thanks
Dinesh Bhagat
Atharva Dhekne 8:13 am on May 27, 2020

Hello @kenshino
I’m interested in expanding on the first project. I would really appreciate your inputs to unify and compose a design/style guide for all documentation falling under WordPress. I’d like to know anything (style/design-wise) that is not documented, or the docs team would like to be standardized in the style guide.
Looking forward to develop on this idea.

Thanks,
tacitonic
- Jon (Kenshino) 3:54 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
  - Atharva Dhekne 6:01 am on June 22, 2020
    
    Thanks for your input!
    
    I’m unclear about the timeline for evaluating and the action plan. Is this during the application phase or after?
Joel Olawanle 4:37 pm on May 30, 2020

Hi @asif2bd,

I’m Joel from Nigeria. I have been a lover of WordPress for a very long time now. Few days ago WordPress celebrated its birthday and I saw a write up of one of the co-founders
Seeing that I made up my mind that I must contribute to WordPress. Then I came across the Google season of docs program and fortunately WordPress is a registered organization.

I read through all the project ideas and they were all lovely but this topic on “Curate Existing HelpHub Article To Create Pillar Contents”(project 5) kept dropping on my mind. I saw its usefulness because I had same issues when learning how to use WordPress. Most articles were scattered and made me confused at first.

I noticed you were the mentor for this and that is why I am sending this message to show interest in the project.

I know I will deliver a Top-Notch documentation at the end of the GSoD program 2020.

I will create a very detailed documentation to bring together all the contents so users can have a pillar content instead of surfing and surfing the internet for help which can be stressful.

I hope to discuss more with you so I can be selected for this project.

Thanks for reading.

I am Joel.
- M Asif Rahman 7:49 am on June 9, 2020
  
  Thanks for reaching out in 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/. as well, where I responded to you. Thanks again for submitting more info.
tharumel 12:45 pm on June 1, 2020

Hi,
I’m Tharu, and I’m working as a Technical Writer for the past 3 years. I was going through the list of organizations participating for GSOD and came across your organization profile. I would like to apply as a TW and I’m interested in the “Improve Existing Development Documentation and Handbooks” project.

Looking forward to hearing from you’ll.

Best,
Tharushi.
- Jon (Kenshino) 3:54 pm on June 21, 2020
  
  Hello and thank you for your interest!
  
  Do you have a question? 🙂
- Jon (Kenshino) 3:58 pm on June 21, 2020
  
  Hello! Thank you for your interest 🙂
  
  Do you have any questions yet?
abutalha94 6:00 am on June 7, 2020

Greetings @kenshino,
Hope you are safe and doing well,
I am interested in Project 2 – “A full and renewed set of documentation style guide”. I took courses on Technical Writing and Communication Skills so I have the relevant knowledge and skills for this project.
I am excited to be part of this project in this “Google Season of Docs”. I will go through all the related material before the application period ends so that I will have an idea of what is currently available and what is needed.
Kind Regards,
Abu Talha
- Jon (Kenshino) 3:57 pm on June 21, 2020
  
  Hello! Thank you for your interest 🙂
  
  Do you have any questions yet?
  - Ab.tal 3:50 pm on June 29, 2020
    
    I am active in 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 have already joined WordPress so maybe I can ask questions in the relative channel from now.
khushbu1983 4:19 pm on June 15, 2020

Hi @milana_cap,
I am khushbu desai. I have been involved with WordPress for the last 2 years. I have recently started contributing to WordPress with the Documentation team. I have started writing for Embed blocks. So naturally, I would like to be part of the project “Extending 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”. In past, I worked as a Business Analyst. So I have experience in developing user docs.

Looking forward to hearing from you.

Kind Regards,
khushbu desai
- Milana Cap 8:29 pm on June 21, 2020
  
  Hi Khushbu,
  
  Thank you for your interest for the project.
  
  Even though we already chat about this 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/., I’ll repost it here so that other interested technical writers can get better idea about the project.
  
  So, this is a developer side documentation. It is meant to teach developers how to start building with 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.
  
  You don’t need to be a developer nor you need to know a lot about Block Editor. This is what Google Season of Docs is all about. You’ll work with people who know all that and we’ll help each other with skills we have.
  
  We have a section for Block Editor tutorials here: https://developer.wordpress.org/block-editor/tutorials/
  We are trying to improve this specific one: https://developer.wordpress.org/block-editor/tutorials/block-tutorial/
  The work on this has already started and is happening 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/: https://github.com/WordPress/gutenberg/pull/22831
  
  Feel free to read through and ask any question you might have on that GitHub pull request.
manthanadmane 12:00 pm on June 16, 2020

Hey guys, my name is Manthan Admane and I will be applying as a technical writer under Google Season of Docs 2020.

I would like to work on the project- ‘Improve Existing Development Documentation and Handbooks’ mentored by @kenshino.

I have been fortunate enough to be a part of the WCEU 2020 and was a part of #docs during the camp which was a great experience. I have also been attending Monday weekly meetings of the doc team and the community feels really warm and welcoming.

Also, I have taken upon the task of ‘Imgur Embed’ under 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 tasks and have been communicating and improving my doc submission.

Any help regarding GSoD proposal or guideline and requirements for the project ‘Improve Existing Development Documentation and Handbooks’ would be appreciated.

Thank you. Looking forward to it : )
- Jon (Kenshino) 3:59 pm on June 21, 2020
  
  Hey. Thank you for already contributing! It’s lovely.
  
  I don’t see any questions from you but hoping comments from https://make.wordpress.org/docs/2020/05/01/season-of-docs-project-list-idea/#comment-39975 would help somewhat
ruchiluthra 7:43 am on June 22, 2020

Hello @johnzenith,

I’m Ruchi and I find the “WordPress Development Configuration Guide” an interesting project to work on. I would like to contribute to organizing, updating, and creating new content for this guide under your mentorship.
This is the first time I’m trying out this so I need your support to put together a proposal for the project.
Something about myself – I’m working as a Senior technical writer for a product company and have an experience of about 9 years. Let me know if you need more information.
Looking forward to collaborating!
ruchiluthra 1:05 pm on June 22, 2020

Hello @johnzenith,

I’m Ruchi Luthra, I’m quite interested in the project “WordPress Development Configuration Guide”. This is the first time for me to contribute Seasons of Docs so looking forward to your guidance to develop a proposal for the same.

Something about myself – I’m a technical writer working for a product based company and have an experience of nine years. let me know if you need more information and where do you want me to start with this.

Looking forward to hearing from you!

Thanks!
- john zenith 7:15 am on June 29, 2020
  
  Hello and am sincerely sorry for the late reply.
  
  There is a follow up comment here where I’ve explained what we are expected to do.
  
  Also, it would be great if you’ve gone through the technical writter guides.
  
  Please don’t hesitate to reach out if you have more questions.
  
  Thank you.
MakeWebBetter 1:35 pm on June 22, 2020

Hello All, I am sharing information regarding my security project –

Project Name: Most Popular Security Attacks

What exactly technical writer need to understand is that in this project we will be exploring some common vulnerabilities or attacks over WordPress websites but not only explanation of the issue.

If we want to break our tasks into sub segments then we must have –

1) Problem statement – Here need explanation of Actual Issue or that specific Vulnerability that occur.
2) Causes – Here need to include some points or loopLoop The Loop is PHP code used by WordPress to display posts. Using The Loop, WordPress processes each post to be displayed on the current page, and formats it according to how it matches specified criteria within The Loop tags. Any HTML or PHP code in the Loop will be processed on each post. https://codex.wordpress.org/The_Loop. holes through which that issue arises or kind of gateway through which hacker code enters into websites.
3) Solution – Now this is the heart section where we need to work most to explain step by step process of solving that vulnerability and secure the website, this section needs a lot of attention.
4) Preventive measures or Recommendations

I got lots of queries on same point like how will i prepare my proposal for this project, So I would like to answer this that according to google technical writer guidelines this can be clearly identified that the technical writer should have prior experience of technical writing and he/she should be eligible to work independently. So everything what needed for proposal is clearly mentioned in Google Guide and specifically for this project what I recommend is to portray the clarity of the project as much as possible in your proposal and for your help I already provide above some sections of this project in point wise .

Don’t hesitate to ask any more question regarding this project .

Thank you

Want to get involved?

Weekly meetings

Season of Docs Project List Idea

Projects

Project One: @kenshino

Project Two: @makewebbetter

Project Three: @kenshino

Project Four: @johnzenith

Project Five: @asif2bd

Project Six: @kenshino

Project Seven: @estelaris

Project Eight: @milana_cap

Project Nine: @marcio-zebedeu

Want to get involved?

Weekly meetings

Projects

Project One: @kenshino

Project Two: @makewebbetter

Project Three: @kenshino

Project Four: @johnzenith

Project Five: @asif2bd

Project Six: @kenshino

Project Seven: @estelaris

Project Eight: @milana_cap

Project Nine: @marcio-zebedeu

Share this: