GSoD: Difference between revisions
m Formating |
m Update page |
||
| Line 1: | Line 1: | ||
[[Category:Mentoring]] | [[Category:Mentoring]] | ||
== About Season of Docs == | == About Season of Docs == | ||
'''This is the central page for organizing KDE's participation in Season of Docs 2021. If you would like to create additional pages, please make them as subpages of this page.''' | |||
'''This is the central page for organizing KDE's participation in Season of Docs | |||
| Line 27: | Line 25: | ||
'''Dates''' | '''Dates''' | ||
* Organization applications start on | * Organization applications start on February 9, 2021. '''The deadline for KDE to apply as an organization is March 26, 2021 at 18:00 UTC''' | ||
* | * Google will announce which organizations have been accepted into the program on April 16, 2021 at 18:00 UTC. | ||
* | * Technical writer hiring deadline on May 17, 2021 | ||
| Line 44: | Line 38: | ||
'''Rules and requirements''' | '''Rules and requirements''' | ||
* KDE must have at least two organization administrators to manage our participation in Season of Docs. | <!-- * 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. | * 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. | ||
| Line 52: | Line 46: | ||
* Our administrators and mentors should register in the Season of Docs system. Registration opens on April 2, 2019 at 20:00 UTC. | * 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 | * The deadline for KDE to apply as an organization is March 26, 2021 at 18:00 UTC. | ||
* 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 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. | ||
| Line 60: | Line 54: | ||
* 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. | * 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. | *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. --> | ||
| Line 71: | Line 65: | ||
== Guidelines == | == Guidelines == | ||
Season of Docs 2021 will operate as a grant program. Accepted organizations will receive between US$5,000 and US$15,000 to use for a documentation project. | |||
Accepted organizations hire technical writers directly. The Season of Docs grants will be disbursed in two payments; 40% upon hiring a technical writer, and 60% after receiving the final evaluation and case study. For more information on receiving grants, please visit our grants for organizations guide. | |||
Interested technical writers can signal their willingness to participate by contacting organizations through their project pages and by adding themselves to the Season of Docs technical writer directory. We encourage interested technical writers to work with organizations to create project proposals. | |||
At the end of the program, the Google program administrators publish the project reports and case studies. Google program administrators will also follow up with the organizations at intervals to ask followup questions about the project metrics. | |||
https://developers.google.com/season-of-docs/docs | |||
== Project Ideas == | == Project Ideas == | ||
'''The deadline for KDE to apply as an organization is April 23, 2019 at 20:00 UTC.''' | '''The deadline for KDE to apply as an organization is April 23, 2019 at 20:00 UTC.''' | ||
| Line 93: | Line 91: | ||
=== Project Proposal Template === | === Project Proposal Template === | ||
Templates for Project ideas is available [https://developers.google.com/season-of-docs/docs/project-ideas here] | |||
=== Overhaul Kirigami documentation === | === Overhaul Kirigami documentation === | ||
Revision as of 11:25, 25 February 2021
About Season of Docs
This is the central page for organizing KDE's participation in Season of Docs 2021. If you would like to create additional pages, please make them as subpages of this page.
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:
- one for announcements: https://groups.google.com/forum/#!forum/season-of-docs-announce
- and one for discussions: https://groups.google.com/forum/#!forum/season-of-docs-discuss
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
Dates
- Organization applications start on February 9, 2021. The deadline for KDE to apply as an organization is March 26, 2021 at 18:00 UTC
- Google will announce which organizations have been accepted into the program on April 16, 2021 at 18:00 UTC.
- Technical writer hiring deadline on May 17, 2021
Full Season of Docs timeline: https://developers.google.com/season-of-docs/docs/timeline
Rules and requirements
Complete Season of Docs rules https://developers.google.com/season-of-docs/terms/program-rules
Guidelines
Season of Docs 2021 will operate as a grant program. Accepted organizations will receive between US$5,000 and US$15,000 to use for a documentation project.
Accepted organizations hire technical writers directly. The Season of Docs grants will be disbursed in two payments; 40% upon hiring a technical writer, and 60% after receiving the final evaluation and case study. For more information on receiving grants, please visit our grants for organizations guide.
Interested technical writers can signal their willingness to participate by contacting organizations through their project pages and by adding themselves to the Season of Docs technical writer directory. We encourage interested technical writers to work with organizations to create project proposals.
At the end of the program, the Google program administrators publish the project reports and case studies. Google program administrators will also follow up with the organizations at intervals to ask followup questions about the project metrics.
https://developers.google.com/season-of-docs/docs
Project Ideas
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
Templates for Project ideas is available here
Overhaul Kirigami documentation
Problem: Kirigami is a relatively new framework to create convergent applications with only little documentation. This makes it difficult for newcomers to use Kirigami. The goal will be to build on previous efforts to improve the documentation and properly document the components with explanations how to use them, code examples, and screenshots. Previous efforts can be found [here].
How would we measure success?
- Users of Kirigami won't need to look at the source code of Kirigami or Kirigami-based applications to build their own Kirigami application.
- Increase the adoption of Kirigami inside KDE and also outside.
What skills would a technical writer need to work on this project?
- Must have: Familiarity with Gitlab/Github merge request workflow (or willingness to work through Gitlab tutorials)
- Nice to have: Previous QML knowledge but if you don't we will help you get started. Doxygen and/or markdown knowledge are also a plus but it easy to learn the syntax.
Volunteers
- Carl Schwan: Happy to help with questions about the documentation tooling and Kirigami.
- Add your name here :p
Contact info:
Technical writers interested in working on this project should contact us on Matrix #developer-doc:kde.org or alternatively send a mail to carl at carlschwan dot eu. Please include links to your technical writing work or portfolio/résumé/CV.