Difference between revisions of "Season of Docs Project Ideas List"

From GNU Radio
Jump to: navigation, search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Technical writing project ideas ==
+
'''Organization''': GNU Radio
  
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.  
+
'''Organization Description''': GNU Radio is a free & open-source software development toolkit that provides signal processing blocks to implement software radios. It can be used with readily-available low-cost external RF hardware to create software-defined radios, or without hardware in a simulation-like environment. It is widely used in hobbyist, academic and commercial environments to support both wireless communications research and real-world radio systems.  
  
See the detailed guidelines on creating your project ideas list at https://developers.google.com/season-of-docs/docs/project-ideas
+
'''Primary code repo''': https://github.com/gnuradio/gnuradio
  
List of project ideas:
+
'''Contact info''': For more information about our organization's Season of Docs, please email Marc at marcll@vt.edu
  
# 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
+
== Technical writing project ideas ==
 +
 
 +
(It may be possible to combine multiple of these items into 1 project)
 +
 
 +
# The technical writer can work with Marc as he 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
 +
 +
Note to devs- Guidelines on creating your project ideas list at https://developers.google.com/season-of-docs/docs/project-ideas

Latest revision as of 17:01, 18 April 2019

Organization: GNU Radio

Organization Description: GNU Radio is a free & open-source software development toolkit that provides signal processing blocks to implement software radios. It can be used with readily-available low-cost external RF hardware to create software-defined radios, or without hardware in a simulation-like environment. It is widely used in hobbyist, academic and commercial environments to support both wireless communications research and real-world radio systems.

Primary code repo: https://github.com/gnuradio/gnuradio

Contact info: For more information about our organization's Season of Docs, please email Marc at marcll@vt.edu

Technical writing project ideas[edit]

(It may be possible to combine multiple of these items into 1 project)

  1. The technical writer can work with Marc as he 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

Note to devs- Guidelines on creating your project ideas list at https://developers.google.com/season-of-docs/docs/project-ideas