Difference between revisions of "GSoD FAQ"
From Audacity Wiki
(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...") |
(first draft.) |
||
| 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.}} | {{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.}} | ||
| + | |||
| + | |||
| + | |||
| + | '''How do you currently document Audacity?''' | ||
| + | * We have two wikis, this wiki for all kinds of information, and 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. | ||
| + | * The manual contains some annotated/clickable screenshots and a sidebar to help navigation. | ||
| + | * We have scripts to collect the manual, we distribute a copy with Audacity, and 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 in terms of potential users/visitors. | ||
| + | |||
| + | '''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] | ||
Revision as of 08:08, 3 April 2019
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.
How do you currently document Audacity?
- We have two wikis, this wiki for all kinds of information, and our 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.
- The manual contains some annotated/clickable screenshots and a sidebar to help navigation.
- We have scripts to collect the manual, we distribute a copy with Audacity, and 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 in terms of potential users/visitors.
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?
