Difference between revisions of "GSoD FAQ"

From Audacity Wiki
Jump to: navigation, search
(tweaks.)
(more.)
Line 17: Line 17:
 
'''Can you say more about the manual?'''
 
'''Can you say more about the manual?'''
 
* The manual is 90% a reference, organised in terms of features of the program.
 
* The manual is 90% a reference, organised in terms of features of the program.
* The manual contains annotated/clickable screenshots and a sidebar to help navigation.
+
** 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 scripts to collect the manual
 
* We have scripts to collect the manual
 
** We distribute a copy with Audacity
 
** We distribute a copy with Audacity
Line 42: Line 44:
 
* (Admin) Steve - Audacity developer, writes some tutorials.  Very active answering user questions on the Audacity forum.
 
* (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.
 
* (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 in documentation or collaborating with technical writers?'''
 
*  
 
*  
 
  
 
'''What previous experience has Audacity had mentoring individuals?'''
 
'''What previous experience has Audacity had mentoring individuals?'''
*  
+
*
  
  
 
'''What editorial principles do you have?'''
 
'''What editorial principles do you have?'''
 
* [https://alphamanual.audacityteam.org/man/Consistency Consistency in Audacity Manual]
 
* [https://alphamanual.audacityteam.org/man/Consistency Consistency in Audacity Manual]

Revision as of 10:34, 3 April 2019

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.


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?

  • Nope. The forum is pretty important for our users questions, and we have a feedback email address which is active too.
    • Frequent questions there end up on our FAQ (which is in the manual).
    • We often refer people to the FAQ in the manual.
  • There is a somewhat experimental 'what is that?' page which repackages the manual in a more visual/interactive format.
  • Our main website has some information about audacity as a project too.
  • Developers will look in 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?


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?