Skip to content

Google Season of Docs 2022

Jump to bottom
Avinal Kumar edited this page Mar 24, 2022 · 3 revisions

Welcome to the project idea page for GSoD 2022.

Introduction

The FOSSology project aims to participate in the upcoming Google Season of Docs 2022. This is the project idea page for the same. Please see the following resources for finding out more about FOSSology in general:

Interested in Application?

Mentors

Interested in becoming a mentor? Please reach out to us!

About the project

Currently, FOSSology has no proper user documentation. Most of the FOSSology guide is written in the wiki pages of the GitHub repository. The wiki pages lack the clarity and navigability of user documentation. Many of the recent developments in the project are not documented or partially documented. The wiki pages have not been updated and maintained in years. Since FOSSology is in active development and one of the top tools for license compliance, a lot of users and organizations keep joining. And onboarding hasn’t been so lovely for them.

Idea

We would like to create user documentation from scratch using one of the most used documentation frameworks e.g. Docusauras, Sphinx, etc. that focuses on easy onboarding, detailed features, and options.

Scope of the project

This project aims to achieve the following goals by the end of the Google Season of Docs period.

  • Create an architecture for the FOSSology user documentation and decide on the categories, chapters, and topics.
  • Decide on a possible candidate for a documentation framework.
  • Research and write clear and rich documentation keeping in mind the technical expertise of the users.
  • Possible pages: Onboarding docs, How-to guides, FOSSology modules description, contribution guides, etc.
  • Incorporate feedback from the FOSSology community into the documentation.

Out of scope

  • Internationalization of the documentation
  • Improving the wiki pages
  • Any other contribution made to the projects
  • Our first goal is to create good user documentation so we are keeping tutorials out of the scope.

Measuring the project success

We are aiming for two technical writers to join us and complete most of the documentation during four months. We will track the project success using open source workflow (issue->pull request->merge) and the amount of work completed. For the least, we aim to achieve the following milestones for the project to be considered successful: A detailed architecture for the user documentation is completed and available. 70% of all goals (pages of documentation) have been completed and published.

Timeline

With two technical writers, this project will take approximately 4 months to complete. The first few weeks will be dedicated to the onboarding and community bonding of the tech writers. However, we expect a detailed timeline from the tech writer once they are hired. Here is an approximate timeline for the project.

Dates Action Items
May 16, 2022 - May 31, 2022 Onboarding and Community Bonding
June 1, 2022 - June 15, 2022 Architecture and framework for the documentation
June 15, 2022 - Sept 15, 2022 Create documentation
Sept 15, 2022 - Sept 22, 2022 Project Completion

Preferred technical writer skills

  • Knowledge of markup languages (markdown, reStructuredText, etc.)
  • Previous Technical writing experience: Blogs, Documentation, GSoD, StackOverFlo, etc.
  • Knowledge about software licensing is not necessary but will be helpful.
  • Ability to set up and use the software and understand it's working, we will be helping you with this but some experience is always nice to have.
  • Good English writing skills (grammatical, choice of words, etc.)

Budget

Budget Item Amount (in USD) Running Total Remarks
Technical writer stipend 4500x2 9000 2 part-time technical writer for 4 months
Mentor/Volunteer stipend 400x2 9800 For 2 mentors/volunteers
TOTAL 9800 USD

References

Clone this wiki locally