GSoD: Difference between revisions

From KDE Community Wiki
Line 102: Line 102:
'''Prerequisites:''' If any specialized tools or technologies are required to complete the project, they should be listed here. If some skills are good-to-have, but not required, they can also be mentioned in this section
'''Prerequisites:''' If any specialized tools or technologies are required to complete the project, they should be listed here. If some skills are good-to-have, but not required, they can also be mentioned in this section


'''Mentor:''' If the person submitting the proposal is willing to also mentor the project, they should put their name here. If submitting a proposal without a defined mentor, leave this field empty. However, proposals without a defined mentor will be given lower priority, and should be discussed in the official kde-sod channel before submitting
'''Mentor:''' If the person submitting the proposal is willing to also mentor the project, they should put their name here. If submitting a proposal without a defined mentor, leave this field empty. However, proposals without a defined mentor will be given lower priority. You should discuss such proposals in [https://webchat.kde.org/#/room/%23kde-sod:kde.org the official kde-sod channel] before adding them to this page.

Revision as of 12:50, 27 March 2019

 
Under Construction
This is a new page, currently under construction!

About Season of Docs

Key Information

Communication

1) The official KDE channel for Season of Docs: https://webchat.kde.org/#/room/%23kde-sod:kde.org

2) Google has two groups that all interested parties - admins, mentors, and technical writers - should join:


3) There is also a Slack channel for Season of Docs, which you can join by clicking the invitation link on the official program page: https://developers.google.com/season-of-docs/docs/discussion


Dates

  • Organization applications start on April 2, 2019 at 20:00 UTC. The deadline for KDE to apply as an organization is April 23, 2019 at 20:00 UTC.
  • Registration for mentors and admins opens on April 2, 2019 at 20:00 UTC.
  • Google will announce which organizations have been accepted into the program on April 30, 2019 at 12:00 UTC.
  • Technical writers can start submitting applications on May 29, 2019 at 18:00 UTC. The deadline for technical writers to apply is June 28, 2019 at 18:00 UTC.
  • Google will announce the list of accepted technical writers and their projects on July 30, 2019 at 18:00 UTC.


Full Season of Docs timeline: https://developers.google.com/season-of-docs/docs/timeline


Rules and requirements

  • KDE must have at least two organization administrators to manage our participation in Season of Docs.
  • We must have at least two mentors for each technical writing project we plan to accept. Mentors do not need to be technical writers by profession.
  • KDE can submit two project ideas in our application for Season of Docs. We will select the ideas from the list of proposals below.
  • Our administrators and mentors should register in the Season of Docs system. Registration opens on April 2, 2019 at 20:00 UTC.
  • The deadline for KDE to apply as an organization is April 23, 2019.
  • Individuals are not allowed to participate in Season of Docs as both mentors and technical writers. In other words, you can't be a mentor for a KDE project and apply as a technical writer to contribute to some other project.
  • Individuals with previous experience in contributing to KDE can apply as technical writers as part of Season of Docs, but they must indicate their previous relationship with the project in their application.
  • Individuals applying to participate as technical writers must be at least 18 years old at time of registration; able to demonstrate prior technical writing experience by submitting role descriptions and work samples; eligible to work in their country of residence during duration of program; and residents of a country not currently embargoed by the United States.
  • KDE is not obligated to use the materials produced by technical writers as part of Season of Docs, regardless of whether the projects are successfully completed or not.


Complete Season of Docs rules https://developers.google.com/season-of-docs/terms/program-rules


Guidelines

Information for Mentors

Information for Technical Writers

Project Ideas

As an organization applying to participate in Season of Docs, KDE can submit two project proposals. Everyone is invited to suggest a project idea!

The deadline for KDE to apply as an organization is April 23, 2019 at 20:00 UTC.

If you have any ideas, please add them to this page as soon as possible. Early proposals will get more attention and feedback because people will have more time to read them.

Keep your proposals simple, with clear descriptions.

Do not add proposals that cannot be accomplished over the duration of the program (three months) or that are not related to KDE.

Feel free to add more than one proposal. You can also indicate your priorities; for example, which one of your proposals you find more important and impactful.

Be prepared to add yourself as a mentor for the project(s) you are proposing, or at least to help find two suitable mentors among KDE community members.

Project Proposal Template

Project: The main idea of your proposed project

Basic work breakdown: What types of tasks will the project include; how they could be distributed throughout the program

Expected results: What needs to be produced to consider the project completed ("definition of done")

Benefit for KDE: How will the community benefit from this project; both short- and long-term

Benefit for the technical writer: What will the technical writer gain from this project (new skills, specific knowledge...)

Prerequisites: If any specialized tools or technologies are required to complete the project, they should be listed here. If some skills are good-to-have, but not required, they can also be mentioned in this section

Mentor: If the person submitting the proposal is willing to also mentor the project, they should put their name here. If submitting a proposal without a defined mentor, leave this field empty. However, proposals without a defined mentor will be given lower priority. You should discuss such proposals in the official kde-sod channel before adding them to this page.