Communicating and reporting project metrics

AlexanderPico commented 5 years ago

Background

As an open source project we have regular reporting duties to diverse stakeholders, including government funding agencies and industry funders. We also feel a strong responsibilty to our communities developers, users and potential users. Currently, we have website pages that list compiled stats and metrics, as well as a roadmap.

Goal

With your help, we'd like to clarify the goals of reporting, identify which metrics are most important, and work on communicating them through diverse media and language, e.g., narratives vs graphs vs infoviz docs, etc.

By the end of GSoD, we like to have:

updated project usage descriptions,
templates for future report, and
a brainstorm of ideas and leads to improve upon longer term.

Technical Skills

Experience with narrative project descriptions ("essential")
Experience with usage graphs and other basic plots ("essential")
Experience with report writing, e.g., annual reports to stakeholders ("nice to have")

Link

Project site

Potential Mentors

Alex Pico

Contact

Alex Pico

12VISHESH commented 4 years ago

Hello sir , I hope you are doing well and safe. I am VISHESH TRIPATHI pursuing BTech CSE . I am fluent in python and R language. Also have experienced in data analytics and visualization. I want to contribute to this project. I am waiting your feedback regarding this project ASAP.

Thanks and regards VISHESH TRIPATHI

AlexanderPico commented 4 years ago

The best application for this project would include links to similar documentation you have written in the past, e.g., monthly/annual reports, presentation of usage stats, roadmaps, etc. The best application would also include a review of the documentation we have already (links in project description) and specific recommendations for improvements.

Please be aware: this is a technical writing project, not a code writing project.

sidkapoor97 commented 4 years ago

Hey @AlexanderPico I was just going through the project and the provided links. I propose to do the project in the following way-

identify the groups of stakeholders involved and their relevant projects
Update the project descriptions.
Find metrics, graphs, data and stats to support the project narrative.
Prepare a party (by party I mean industry personnel, govt. etc in broader terms) specific template which can include SOPs, objectives, basic graphs etc.
Decide on what fits the best i.e. graphs vs charts vs infoviz.

I went to the links Usage Stats and Roadmap and we can possibly have different sections to show how the project helps different parties in their relevant space. I am fluent in Python, js and react.js. I have been learning spinx and other static website generation tools. Any feedback would be really helpful on this.

Please take a look at the following for my sample work

project description - One of my project's report
portfolio written in html css with js backend (still ongoing) Looking forward to work on this.

AlexanderPico commented 4 years ago

@sidkapoor97 Very nice. The approach looks sound to me. Please draft an application fleshing out each point in more detail. Feel free to use real usage data (or fake data that we haven't collected yet) in preparing mockups and examples. I'd also recommend proposing two phases: one that focuses on an incremental improvement to what we have already (to guarantee deliverable progress) and a subsequent phase that is more involved (i.e., would be nice to have). If you prepare your draft as a Google doc, you could then share access with me and other potential mentors. Email directly to include links to your draft, etc.

sidkapoor97 commented 4 years ago

Sure, thanks for the feedback I will start working on it right away. That makes sense I was thinking of the same while drafting. I shall share the links with you and other potential mentors.

AlexanderPico commented 4 years ago

@sidkapoor97 Also, given your js skills, you might also want to consider Project #3. According to the rules, you are allowed to submit a maximum of 3 applications.

madi1234-oss commented 4 years ago

Hello, I hope you are doing great. I Madeeha from Pakistan. As a Biotech-Engineer, I would like to join this community.

AlexanderPico commented 4 years ago

@madi1234-oss Welcome. These are all open source projects that you can contribute to and reuse at any time. The Google Summer of Code (GSoC) program is for software engineers. That's already begun for 2020. The Google Season of Docs (GSoD) program is for technical writers.

madi1234-oss commented 4 years ago

Dear Alexander Pico, I want to use GSoD platform as a technical writer, i have experience of writing as my two research articles have been published on international scientific Journals. In addition, I have completed my Bachelors and M.Phil. with participating in so many assignments and poster presentations.

Regards

Sent from Yahoo Mail on Android

On Tue, Jun 9, 2020 at 2:27 AM, Alexander Piconotifications@github.com wrote:

@madi1234-oss Welcome. These are all open source projects that you can contribute to and reuse at any time. The Google Summer of Code (GSoC) program is for software engineers. That's already begun for 2020. The Google Season of Docs (GSoD) program is for technical writers.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

AlexanderPico commented 4 years ago

Great. Timeline and instructions for GSoD are here: https://developers.google.com/season-of-docs/docs/timeline

dA505819 commented 4 years ago

@AlexanderPico I have Submitted the proposal. Please have a look at it so that I can fulfill the missing part. Thank you, Regards

nrnb / GoogleSeasonOfDocs