Difference between revisions of "GSoD FAQ"

From Audacity Wiki
Jump to: navigation, search
(Created page with "{{note|The Audacity audio editor is downloaded around 18 million times each year. It's a large, mature and clearly popular open source project. In 2008 and 2009 we participa...")
 
(cats.)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{note|The Audacity audio editor is downloaded around 18 million times each year.  It's a large, mature and clearly popular open source project.  In 2008 and 2009 we participated in Google's Summer of Code, taking 7 students in all.  For Google Season of Documentation 2019 we would like to mentor one technical writer.}}
+
{{GSoD_Header|This page answers frequently asked Google Season of Docs for Audacity questions}}
 +
 
 +
 
 +
==Audacity and Google Season of Docs==
 +
{{note|The Audacity audio editor is downloaded around 18 million times each year.   
 +
 
 +
It's a large, mature, popular open source project.   
 +
 
 +
In 2008 and 2009 we participated in Google's Summer of Code, taking 7 students in all.   
 +
 
 +
For Google Season of Documentation 2019 we would like to mentor one technical writer.}}
 +
 
 +
 
 +
==The Questions==
 +
 
 +
'''How do you currently document Audacity?'''
 +
* We have two wikis:
 +
** [[Audacity_Wiki_Home_Page|This wiki for all kinds of information]]
 +
** Our [https://alphamanual.audacityteam.org/man/Main_Page wiki for the manual].
 +
 
 +
 
 +
'''Can you say more about the manual?'''
 +
* The manual is 90% a reference, organised in terms of features of the program.
 +
** We do have [https://manual.audacityteam.org/man/tutorials.html some tutorials too].
 +
** [https://manual.audacityteam.org/quick_help.html 'Getting Started' tutorials] are featured in Audacity itself.
 +
* Navigation: The manual contains annotated/clickable screenshots and a sidebar to help navigation.
 +
* We have [https://github.com/audacity/audacity/blob/master/scripts/mw2html_audacity/mw2html.py scripts to collect the manual]
 +
** We distribute a copy with Audacity
 +
** Help buttons in Audacity link to many of the pages.
 +
 
 +
 
 +
'''Can you say more about this general wiki?'''
 +
* It's a rag bag of miscellaneous information, and that's fine.  That's what it is for.
 +
* It does have some organisation [[Contribute|for potential contributors]].
 +
 
 +
 
 +
'''Is that everything?'''
 +
* No.  [https://forum.audacityteam.org/ The Audacity forum] is vital for our users, and we have a feedback email address which is active too.
 +
** Frequent questions on forum are added to our [https://alphamanual.audacityteam.org/man/FAQ FAQ (in the manual)].
 +
** We often refer people on the forum to the [https://alphamanual.audacityteam.org/man/FAQ FAQ in the manual].
 +
* There is a [https://wit.audacityteam.org/ somewhat experimental 'what is that?' page] which repackages the manual in a more visual/interactive format.
 +
* [https://www.audacityteam.org/ Our main website] has some information about audacity as a project too.
 +
* Developers will look in [https://github.com/audacity/audacity/blob/master/win/build.txt our source code] for code documentation and building instructions.
 +
 
 +
 
 +
'''What experience do your mentors and admins have?'''
 +
* (Mentor) Peter - Principle writer and maintainer on the manual
 +
* (Mentor) James - Audacity developer, does some writing about new features.  Works on templates and automation that (should) reduce work in images and tables.
 +
* (Admin) Steve - Audacity developer, writes some tutorials.  Very active answering user questions on the Audacity forum.
 +
* (Admin) Buanzo - Our Sysadmin.  Helps users with FFmpeg and LAME Audacity plug-ins.
 +
 
 +
 
 +
 
 +
'''Where can I find Google Season of Docs ideas?'''
 +
* [[GSoD Ideas]]
 +
 
 +
 
 +
 
 +
'''What previous experience has Audacity had in documentation or collaborating with technical writers?'''
 +
*
 +
 
 +
'''What previous experience has Audacity had mentoring individuals?'''
 +
*
 +
 
 +
 
 +
'''What editorial principles do you have?'''
 +
* [https://alphamanual.audacityteam.org/man/Consistency Consistency in Audacity Manual]
 +
 
 +
[[Category:Participation]][[Category:GSoD]]

Latest revision as of 11:03, 3 April 2019

Google Season of Docs (GSoD) is Google's program for promoting Open Source Software documentation.
This page answers frequently asked Google Season of Docs for Audacity questions
 
Related article(s):


Audacity and Google Season of Docs

The Audacity audio editor is downloaded around 18 million times each year.

It's a large, mature, popular open source project.

In 2008 and 2009 we participated in Google's Summer of Code, taking 7 students in all.

For Google Season of Documentation 2019 we would like to mentor one technical writer.


The Questions

How do you currently document Audacity?


Can you say more about the manual?

  • The manual is 90% a reference, organised in terms of features of the program.
  • Navigation: The manual contains annotated/clickable screenshots and a sidebar to help navigation.
  • We have scripts to collect the manual
    • We distribute a copy with Audacity
    • Help buttons in Audacity link to many of the pages.


Can you say more about this general wiki?

  • It's a rag bag of miscellaneous information, and that's fine. That's what it is for.
  • It does have some organisation for potential contributors.


Is that everything?


What experience do your mentors and admins have?

  • (Mentor) Peter - Principle writer and maintainer on the manual
  • (Mentor) James - Audacity developer, does some writing about new features. Works on templates and automation that (should) reduce work in images and tables.
  • (Admin) Steve - Audacity developer, writes some tutorials. Very active answering user questions on the Audacity forum.
  • (Admin) Buanzo - Our Sysadmin. Helps users with FFmpeg and LAME Audacity plug-ins.


Where can I find Google Season of Docs ideas?


What previous experience has Audacity had in documentation or collaborating with technical writers?

What previous experience has Audacity had mentoring individuals?


What editorial principles do you have?