Season of Docs: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
* The technical writer is very unlikely to have any experience with DSP and wireless comms, and may not even know how to code. But what we can do is have them do the GRC tutorials and as part of that process they will learn the basics of GNU Radio, and maybe gain some insights or ideas about how the documentation should be improved. | * The technical writer is very unlikely to have any experience with DSP and wireless comms, and may not even know how to code. But what we can do is have them do the GRC tutorials and as part of that process they will learn the basics of GNU Radio, and maybe gain some insights or ideas about how the documentation should be improved. | ||
* We will only ask for 1 technical writer, and Marc will be the mentor. | * We will only ask for 1 technical writer, and Marc will be the mentor. | ||
* The focus will be on the User Docs and tutorials | |||
Revision as of 16:31, 18 April 2019
- This year (2019), Google's Season of Docs is providing paid technical writers to work with open source projects, in order to improve documentation!
- During the program, technical writers spend a few months working closely with an open source community. They bring their technical writing expertise to the project's documentation, and at the same time learn about the open source project and new technologies.
- The open source projects work with the technical writers to improve the project's documentation and processes. Together they may choose to build a new documentation set, or redesign the existing docs, or improve and document the open source community's contribution procedures and onboarding experience.
- The technical writer is very unlikely to have any experience with DSP and wireless comms, and may not even know how to code. But what we can do is have them do the GRC tutorials and as part of that process they will learn the basics of GNU Radio, and maybe gain some insights or ideas about how the documentation should be improved.
- We will only ask for 1 technical writer, and Marc will be the mentor.
- The focus will be on the User Docs and tutorials