GSoD 2021 Organization Application - STEllAR-GROUP/hpx GitHub Wiki

Organization application

Open-source organization's email address

fellows at stellar-group dot org

Open-source project name

HPX

Link to the open-source project

https://github.com/STEllAR-GROUP/hpx

Open-source project description

HPX is a distributed C++ library for concurrency and parallelism. It implements APIs defined in the C++ Standard Library and extends them to work in a distributed memory space. In this way, HPX exposes a unified programming model which transparently utilizes available resources. Our work is closely aligned with the C++ Standard and the ongoing C++ standardization process.

Link to your organization’s page about Season of Docs

https://github.com/STEllAR-GROUP/hpx/wiki/GSoD-2021-Project-Ideas

Does your organization want to accept the mentor stipend?

Yes

Primary administrator's full name

Patrick Diehl

Primary administrator's display name

diehlpk

Are you participating as a mentor in Season of Docs?

No

Alternative administrator's full name

Mikael Simberg

What previous experience has your organization had in documentation or collaborating with technical writers?

Our organization has experience in writing documentation for HPX. We have documentation for the API, for Developers, and some Quickstart for using HPX. However, the documentation was written by our open source contributors, and none of them has any professional experience in technical writing. We got feedback, mostly via GitHub issues, from users and tried to improve the documentation using their user experience.

We had the chance to work with one technical writer, who worked with us during Google Season of Docs 2019, on the project Edit and streamline the content of the existing HPX documentation. She was supposed to work on a couple of sections of the documentation. She was able to edit all of our existing documentation and even continued her contributions after the GSoD period contributing 7 pull requests (of which 4 were merged).

We had an amazing learning experience improving our documentation with the previous year's GSoD student. We are applying based on our previous experience to cooperate with a technical writer. We believe that the technical writer improves their skills by working on a completely new project/codebase, while we benefit from the improvements in our documentation. Furthermore, our open-source contributors learn to write effective documentation from the technical know-how that the writer brings to the table.

What previous experience has your organization had mentoring individuals?

Our organization was selected for Google Summer of Code six times, and we mentored approximately 25 students. We also participated in Google Season of Documentation in 2019 and got acquainted with how to work with technical writers. Additionally, some of our organization members work in academia and have plenty of experience supervising/mentoring undergraduate and graduate students.

How many technical writers does your organization want to mentor this year?

1 or 2 -> 1

Link to project ideas list

https://github.com/STEllAR-GROUP/hpx/wiki/GSoD-2021-Project-Ideas

Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️