Season of Docs Project Ideas List: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
See the detailed guidelines on creating your project ideas list at https://developers.google.com/season-of-docs/docs/project-ideas
See the detailed guidelines on creating your project ideas list at https://developers.google.com/season-of-docs/docs/project-ideas


List of project ideas:
List of project ideas (note that the project can just contain all items below):


# The technical writer can work with Marc as Marc creates the "One page per block" section of the User docs, inspired by MATLAB's documentation
# The technical writer can work with Marc as Marc creates the "One page per block" section of the User docs, inspired by MATLAB's documentation
# Our tutorials could definitely use a technical writer to improve, and they could even do the GRC (less technical) tutorials as part of that effort, to learn more about GNU Radio throughout the Fall
# Our tutorials could definitely use a technical writer to improve, and they could even do the GRC (less technical) tutorials as part of that effort, to learn more about GNU Radio throughout the Fall
# The Usage Manual is an area of documentation that gets a lot of exposure, because it explains a lot of GNU Radio's basic concepts like messages, tagging, PMTs, etc.  Our Usage Manual could definitely use refinement
# The Usage Manual is an area of documentation that gets a lot of exposure, because it explains a lot of GNU Radio's basic concepts like messages, tagging, PMTs, etc.  Our Usage Manual could definitely use refinement

Revision as of 16:55, 18 April 2019

Technical writing project ideas

Note from Google- This list should include one or more documentation projects that you'd like a technical writer to tackle during this year's Season of Docs.

See the detailed guidelines on creating your project ideas list at https://developers.google.com/season-of-docs/docs/project-ideas

List of project ideas (note that the project can just contain all items below):

  1. The technical writer can work with Marc as Marc creates the "One page per block" section of the User docs, inspired by MATLAB's documentation
  2. Our tutorials could definitely use a technical writer to improve, and they could even do the GRC (less technical) tutorials as part of that effort, to learn more about GNU Radio throughout the Fall
  3. The Usage Manual is an area of documentation that gets a lot of exposure, because it explains a lot of GNU Radio's basic concepts like messages, tagging, PMTs, etc. Our Usage Manual could definitely use refinement