Skip to content

Season of Docs Information 2021

Nathan Tatum edited this page Feb 22, 2021 · 1 revision

BioGears

About Us: BioGears is an open source, comprehensive, extensible human physiology engine released under the Apache 2.0 license that will drive medical education, research, and training technologies. BioGears enables accurate and consistent physiology simulation across the medical community. The engine can be used as a standalone application or integrated with simulators, sensor interfaces, and models of all fidelities

About our project: Tell us about the problem your project will help solve. Why is it important to your organization or project to solve this problem?

Project Scope: Tell us about what documentation your organization will create, update, or improve. If some work is deliberately not being done, include that information as well. Include a time estimate, and whether you have already identified organization volunteers and a technical writer to work with your project.

Measurements of Success: How will you know that your new documentation has helped solve your problem? What metrics will you use, and how will you track them?

How we define a successful season: Create measurable goals

Project budget: General guidelines You can include your budget in your proposal, or as a separate link. If your budget is fewer than ten items, we recommend including it in your proposal. All budgets should be in US dollars. We expect grants to range from US$5000 to US$15000; if your project is outside of that range, please provide additional information to justify your budget. We expect the bulk of your budget (60-70% minimum) to be allocated to the technical writer working on your project. We recommend budgeting on a per-project basis wherever possible. We expect open source projects to use open source tools whenever possible; if your project absolutely requires funds for proprietary software licenses or support, please include a justification for the amount.

Other possible expenses include: Design work to create branding, logos, templates, or other design assets for your documentation site Minimal amounts (<US$200) for project swag (t-shirts or stickers for your participants). If you use the Season of Docs logo, it must be accompanied by your project or organization logo or name. Your swag may not use the name Google. Minimal stipends for volunteers who take on considerable mentorship or guidance roles in the project (we recommend no more than $500 per volunteer, please) Downstream donations to other open source projects should be no more than 10% of your budget total. Include other budget items as needed, along with justification for the amount sought. Expense justifications should highlight how the expenditure will contribute to the success of the project as a whole.

Additional information: Include here any additional information that is relevant to your proposal.

Previous experience with technical writers or documentation: If you or any of your mentors have worked with technical writers before, or have developed documentation, mention this in your application. Describe the documentation that you produced and the ways in which you worked with the technical writer. For example, describe any review processes that you used, or how the technical writer's skills were useful to your project. Explain how this previous experience may help you to work with a technical writer in Season of Docs.

Previous participation in Season of Docs, Google Summer of Code or others: We participated in Google Summer of Code for the first time in the Summer of 2020. We mentored two students, considered both successful in their ventures, and maintained involvement of one of them within our community. We are currently applying for our second Summer of Code participation acceptance.