Editing Season of Docs Proposal

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 36: Line 36:
 
# Anything related to the Doxygen documentation, which is developer-centric and is currently in a poor shape, but it's essentially just automatically generated from information in-line with the code, so it's still useful for the core developers who are actually working on GNU Radio code itself.   
 
# Anything related to the Doxygen documentation, which is developer-centric and is currently in a poor shape, but it's essentially just automatically generated from information in-line with the code, so it's still useful for the core developers who are actually working on GNU Radio code itself.   
 
# GNU Radio Companion (GRC) improvements
 
# GNU Radio Companion (GRC) improvements
# Documentation part of any 3rd party Out of Tree Modules, because they are not maintained by the GNU Radio Project
 
  
 
We have already identified two members of our leadership that will act as mentors for the technical writer; Marc and Barry.  These are the two members of leadership that have been focused on improving our documentation over the last year or two.  In terms of an estimated time, it's tough to put a number on it, we believe we can use any amount of time we can get from a technical writer, although three months seems like a good amount of time.
 
We have already identified two members of our leadership that will act as mentors for the technical writer; Marc and Barry.  These are the two members of leadership that have been focused on improving our documentation over the last year or two.  In terms of an estimated time, it's tough to put a number on it, we believe we can use any amount of time we can get from a technical writer, although three months seems like a good amount of time.

Please note that all contributions to GNU Radio are considered to be released under the Creative Commons Attribution-ShareAlike (see GNU Radio:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)