Google Season of Docs 2024
GSoD is a Google program to connect professional technical writers with open source projects.
https://developers.google.com/season-of-docs?hl=de
On this page, we can collect ideas for our participation in the 2024 round of GSoD. Add your ideas by creating a new proposal!
About your organisation
Inkscape (current version 1.3.2, first released in 2003) is a GPL-licensed program for creating artwork using SVG as its native format. It is available for Linux, Windows and macOS, and is the only major vector graphics software (open-source or proprietary) available on Linux. Our millions of users are scientists, designers, engineers, makers and hobbyists who create scientific publications, web graphics, logos, book illustrations, comics, game assets, or technical drawings and sketches - any type of graphics that requires scalability. Our contributors have a wide range of backgrounds, similar to our users, with a healthy mix of long-term and drive-by contributions.
Inkscape is a member of the Software Freedom Conservancy.
About your project: Update Inkscape's Beginners' guide
Inkscape has an official user manual hosted at ReadTheDocs, which covers basic usage of Inkscape, with guides on drawing tools, colors, text, etc. However the manual is currently targeting Inkscape 1.1, while the latest version is 1.3.2. In between, there are a number of undocumented changes, such as the new Live Path Effects dialog, on-canvas pattern editing, spiro and BSpline path support, multiple pages support, shape builder and more. Other parts of the manual (shortcuts, icons, etc.) also need updating to reflect the current user interface. These missing functionalities and outdated instructions confuse newcomers, which the manual primarily targets. Additionally, the manual lacks consistency in the colors and resolutions used in figures and the comprehensiveness of tool descriptions. The manual also lacks a contribution guide, including how to contribute translations, which makes it difficult for new contributors to help with user-facing documentation.
Your project's scope
The Inkscape Beginner’s Guide update project will:
- Review the current guide and mark all places that needs an update within a Gitlab issue (with sub-issues if needed).
- Add pages and paragraphs for new tools in appropriate locations, such as the Pages tool and the Measure tool under 'Useful Techniques', the filter editor dialog in the 'Filters' page, the new color wheel in the 'Fill and Stroke' page, etc.
- Update parts of the guide according to the aforementioned issue.
- Create a 'style guide' in the README documenting the tone of voice of the guide, colors and proportions used for figures. Include information about the translation process in the contributors guide, and document language-specific details (such as the use of “you” and “we” in English).
- Re-capture screenshots of the current interface and redraw figures according to the style guide.
- Edit the guide to make wording and grammar consistent.
- Work with the inkscape-docs team to update the documentation on the ReadTheDocs site.
Work that is out-of-scope for this project:
- This project will not create tutorial pages that incorporates multiple tools. (This comes after the project ends)
For this project, we already have a good candidate for the technical writer role. Documentation team lead @Moini [limited availability] and Project Leadership Committee member @joneuhauser are available as mentors.
Measuring your project's success
The Inkscape forum and chatroom currently recieves a number of questions per day, some of which are related to new features, therefore we aren’t able to refer them to the manual. The improved documentation would give people a definitive source to point to when answering questions, and we hope it helps people understand the tools further in addition to solving the problem. We also think that the contribution guide would help aspiring manual writers and translators make their first contribution, which hopefully makes them stick around and contribute further.
We will track the number of total visitors monthly, and the amount of merge requests and issues opened quarterly after the manual is updated.
We will consider the project successful if, after publication of the new manual:
- The number of individual visitors (indicated by ReadTheDocs) increases by 15%
- Translations for at least one additional language is being worked on
- The number of contributors who have made >3 contributions increases by 10% (beginning the quarter after the documentation is published)
Timeline
The project will take approximately 6 months to complete. We’ll spend a month creating the style guide and documenting required changes and additions, 4 months editing and creating pages, and 1 month revising all aspects of the manual adhering to the style guide.
| Dates | Action Items |
|---|---|
| May | Create style guide and document required changes and additions |
| June - September | Edit and create pages |
| October | Revise the text and figures |
| November | Project completion |
Project Budget
| Budget item | Amount | Running Total | Notes/justifications |
|---|---|---|---|
| Technical writer, manual update. | 12500.00 | 12500.00 | |
| Volunteer stipends | 500.00 | 13500.00 | 2 volunteer stipends x 500 each |
| Software Freedom Conservancy fee | 1500.00 | 15000.00 | Inkscape is a member of SFC (as suggested also on the GSoD documentation), and due to our fiscal sponsorship agreement, the SFC takes a 10% cut of the gross income of the project. |
| TOTAL | 15000.00 |
Additional information
- Previous experience with technical writers or documentation: Inkscape maintains a website with user and developer documentation. Keeping this website current is a one of the most difficult problems we face. All contributions have been made by volunteers.
- Previous participation in Google Season of Docs, Google Summer of Code or others: Inkscape has participated in Google Summer of Code every year except for one, since its inception. GSoC students have made significant contributions to Inkscape.
For interested technical writers
Thanks for considering Inkscape for your GSoD project! In order to apply, we ask you to complete a short list of tasks & answer a few questions.
- Introduce yourself on the Inkscape chat (Room #documentation), and get in touch with the team.
- Subscribe to the documentation team mailing list (very low volume). This is needed so you can send your application later on! There's no need to create an account there, just subscribe using your email address.
- Checkout the source code of the Beginner's guide through git and review it. Make sure you can build the guide on your own PC!
- Try to find a single mistake in the manual you just compiled, and submit a merge request through Gitlab for it. If you need help with that, don't hesitate to ask in the chat. A mistake can be as small as a typo, but maybe also an outdated instruction that doesn't work for you with the latest version of Inkscape. With this, we can assert that you are able to work with version control tools.
- Prepare a detailed plan (with timetable) of the work you want to do. This should roughly follow the items listed above, but feel free to set priorities / a different focus! Discuss changes with the team first via chat.
Questions:
- What is your name, email address, and chat nickname?
- What's your availability during the project (in particular, timezone)
- What technical writing projects have you completed?
- Describe any work on other open-source projects.
- Why should we pick you?
All set? Great! Send your application to the documentation team mailing list until April 21, 2024, 18:00 UTC.