Skip to content

Instantly share code, notes, and snippets.

View jeromefv's full-sized avatar

Jerome Villegas jeromefv

View GitHub Profile

nteract Documentation Project Report

Introduction

The nteract documentation improvements through this project consist of clearer and prominent navigation formatting, concise and generalized language, as well usability testing for understanding the community experiences. During the project, as a technical writer, I audited the content for organization, improved language accessibility, implemented enhanced formatting and theming, as well as distributed and collected feedback from nteract users.

With the help of the nteract team, I began learning about the tools necessary for the project. We collaborated through Slack, email, virtual meetings, and GitHub in building and improving the new documentation. Throughout the timeline I developed, we met the targets of deploying an updated build of the documentation as well as collected information from the initial community survey.

Some content related to specific groups require additional text with support from developers. The plans for the material are in th

@jeromefv
jeromefv / Matplotlib_GSoD_jeromefv.md
Last active January 10, 2021 21:56
GSoD 2020: Developing Matplotlib Entry Paths

Developing Matplotlib Entry Paths

Saturday, December 5th 2020
Google Season of Docs: Matplotlib
Technical Writer: Jerome Villegas

Introduction

This year’s Google Season of Docs (GSoD) provided me the opportunity to work with the open source organization, Matplotlib. In early summer, I submitted my proposal of Developing Matplotlib Entry Paths with the goal of improving the documentation with an alternative approach to writing.

I had set out to identify with users more by providing real world contexts to examples and programming. My purpose was to lower the barrier of entry for others to begin using the Python library with an expository approach. I focused on aligning with users based on consistent derived purposes and a foundation of task-based empathy.