├── README.md └── TEMPLATE.md /README.md: -------------------------------------------------------------------------------- 1 | # GoogleSeasonOfDocs 2 | Fostering open source collaboration with technical writers. 3 | 4 | * [Program description](https://developers.google.com/season-of-docs/) 5 | * [Timeline](https://developers.google.com/season-of-docs/docs/timeline) 6 | * [Project Ideas](https://github.com/nrnb/GoogleSeasonOfDocs/issues) 7 | 8 | The National Resource for Network Biology (NRNB) has participated in Google Summer of Code for over a decade. The Season of Docs is a complementary program focused on all levels of documentation for our open source projects. See [Project Ideas](https://github.com/nrnb/GoogleSeasonOfDocs/issues) for specific proposals of what we'd like to work on together with professional technical writers. 9 | -------------------------------------------------------------------------------- /TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ### Background 2 | 3 | * Describe the open source project that needs documentation. 4 | * Describe the status of existing relevant documentation. 5 | * If you're proposing a tutorial or a set of how-to guides, describe the features or use cases that need documenting. 6 | * If you're proposing a contributor's guide, link to any existing README file or other relevant material if present. 7 | 8 | ### Goal 9 | Describe what the end result of the project should be. 10 | 11 | ### Technical Skills 12 | List technologies that the writer should be familiar with. Also note if these are "essential" vs. "nice to have". 13 | 14 | ### Link 15 | Provide link to current documentation or project site that needs documentation 16 | 17 | ### Potential Mentors 18 | My Name 19 | Someone Else 20 | 21 | ### Contact 22 | [My Name](mailto:myname@yadayadayada.com) 23 | --------------------------------------------------------------------------------