Page MenuHomePhabricator

GSoD 2020: Week 1
Closed, ResolvedPublic

Description

This task is a break-down of the first week of GSoD based on the timeline T255360: GSoD 2020 Proposal: Improving Wikimedia's onboarding processes and documentation standards.

Related tasks for other weeks can be found here T262918: GSoD 2020

Tasks (September 14 - 18)

  • Analyze the project in detail with my mentors.
  • Discuss:
    • How often the tasks should be reviewed.
    • Share schedules and decide on a weekly/daily workflow.
    • Tools and resources that can be used.
    • Bi-weekly and daily project reports.
  • Prioritize which genres to work on first during weeks 2-4
  • Which other genres are closely related to or similar to this genre? Can other templates be derived from this for them?
  • Identify what kind of audience uses each genre.
  • Highlight the basic requirements for each genre.

This week, I am selecting 3 genres that I would prioritize as the first genre to develop starting templates for. This task documents my thought process and reason for selecting each genre.

Things I looked out for

  • How many documentations fall under these genres?
  • How applicable are these genres to Wikimedia projects?

There is no exact metric for my choice of genres based on the above criteria. This is just me looking around at a few projects and judging based on my instincts. I am really open to suggestions on which genres could be better off starting with, but for now, the below are the ones I chose.

Why did I choose the above?

I feel there are a lot of documentations evolving around walkthroughs, tutorials and how to use specific tools and projects as well as quite a lot of APIs that have been documented.

The Quick Starter guide can come in handy for Creating Onboarding Micro tasks by creating a section for it in its genres template. This would particularly enforce a process for it without having to create further documents explaining it.

Who uses each genre?

1) Walkthroughs, how tos and tutorials

This particular genre is used by everyone and can be useful in every form of technical documentation. Beginners should be highly considered when creating a structure for this genre as people who go through walkthroughs are often people with little to no familiarity with the project setup or usage.

2) Quick Start Guide

This used by people who want to quickly get started with project setup. There should be a fair amount of beginner-skilled ratio here, but it should generally be short, concise, and go straight to the point.

3) API Documentation, SDK (Software Development Kit) Documentation
  • Yet to think this through thoroughly

Closely related genres

Which genres are closely related to each other? Can other templates be derived from this for them?

  • Quick Starter Guide is closely related to Walkthroughs, how tos and tutorials and can be considered a subset of it.
  • A README could be considered a Quick Starter Guide or better still serve the same purpose.
  • Datasheet and Technical Specifications seems closely related (More research will be done regarding this)

To-do

  • Highlight the basic requirements for each genre.
  • Identify what kind of audience uses each genre.
  • Which other genres are closely related to or similar to this genre? Can other templates be derived from this for them?

Event Timeline

Aklapper renamed this task from T255360 week 1 to GSoD 2020: Week 1.Sep 15 2020, 12:27 PM
Aklapper updated the task description. (Show Details)

(I've adjusted the task title so that people who only see the title and don't have any context can get an idea what this is about. Welcome and thanks for your work! :) )

GSoD 2020 is complete!