Skip to content

Commit d5e84a5

Browse files
authoredMar 22, 2022
Update 2021-03-26-GSoD-application.md
1 parent 010a81b commit d5e84a5

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed
 

‎_posts/2021-03-26-GSoD-application.md

+49-1
Original file line numberDiff line numberDiff line change
@@ -118,4 +118,52 @@ We would consider the project successful if, after publication of the new docume
118118
- The standard metrics increased by 10% on average
119119
- The number of forks and stars in our repository increased by 10%
120120

121-
121+
## Project budget
122+
123+
| Budget item | Amount | Running Total | Notes/justifications |
124+
|---|---|---|---|
125+
| Technical writer audit, update, test, and publish reference documentation of GeomScale project | 10000.00 | 10000.00 | |
126+
| Volunteer stipends | 500 | 11500.00 | 3 volunteer stipends x 500 each |
127+
| TOTAL | | 11500.00 | |
128+
129+
130+
## Additional information
131+
132+
### Previous experience with technical writers or documentation:
133+
134+
Members of GeomScale have experience in developing and reviewing documentation.
135+
For example in developing and mentoring documentation development
136+
for [`R` CRAN package volesti](https://CRAN.R-project.org/package=volesti).
137+
The review process used was similar to a coding review. Examples of documentation
138+
review process in GeomScale are available from
139+
[github](https://github.com/boostorg/geometry/pulls?q=is%3Apr+is%3Aclosed+label%3Adocumentation).
140+
In addition to this we usually employ a last step of iterating the final draft
141+
of documentation to our peers and users for feedback.
142+
143+
Our previous experience with documentation development gives us confidence to
144+
apply best practices and well established review processes and tools to the
145+
potential GSoD projects. For example, the GSoD project development will take
146+
part in github by opening issues for discussion and pull requests
147+
(with a documentation tab) to submit/review the technical writer's contributions.
148+
149+
### Previous participation in Season of Docs, Google Summer of Code or others:
150+
151+
All the members of GeomScale have previously participated in Google Summer of
152+
Code as mentors or/and as students. Our members have mentored 7 GSoC coding
153+
projects under `R`-project and Boost `C++` libraries organizations (2017-2019).
154+
The main software package of GeomScale has been substantially enhanced through
155+
3 GSoC projects under the mentoring of two of GeomScale’s members, while one
156+
student of those projects (Apostolos Chalkis) became a GeomScale member and
157+
GSoC mentor and admin.
158+
159+
The last three years (2020-2022) GeomScale has been selected as a mentoring
160+
organization for GSoC. In 2021 we have successfully mentored 5 projects
161+
resulting in >10 pull requests all of which are merged into our repositories
162+
development branch.
163+
164+
We strongly believe that this experience will play a crucial role for
165+
successful GSoD projects. In particular, we have experience in communicating
166+
with persons of diverged educational and cultural background and focused
167+
to give the right tips and guidance for successful projects. Moreover,
168+
we are capable of fixing detailed and realistic time schedules based on
169+
the technical writer’s profile and potential.

0 commit comments

Comments
 (0)