ToDo

From Audacity Development Manual
Revision as of 09:34, 19 December 2007 by Windinthew (talk | contribs) (Decisions: Comment)
Jump to: navigation, search
On any page which needs attention before it is ready for the manual, insert a link to this page by adding:

<div class="editornote">[[ToDo]] explanation of what needs to be done </div>

to that page. Be clear about the changes that are needed. Then anyone who visits this ToDo page can click on 'What Links Here' in the left sidebar to get a list of all pages with work to do comments.

Decisions

  • We're not documenting all effects or all analyze menu items on a page-of their own. Only the most complex ones that require a screenshot will get that treatment. We don't have the time to do them all.
  • Most effects and most analyze menu items will appear on the relevant page about that menu.
  • The reference section should avoid tutorial exposition. It's kept brief, and links to tutorial sections as needed. (Should be viewed intelligently, so as to avoid shunting users around too much, and avoiding creation of half-page "tutorials" for the sake of it which is a significant reason for our duplication problem).

Sub-projects

Here are some specific ToDo projects...

  • Images needed: Transcription Toolbar
  • License information about LAME (from other wiki?), how to get hold of it.
  • Different modes for the tracks, (spectrum, db, waveform)

Low Priority

  • Technical info: nice to have... cepstrum (on plot spectrum), what an FFT is, why dB use logs, 'why you get clicks' when you remove sound.

The html manual distributed with Audacity is primarily the reference section. Tutorials and so on are nice to have with it, but are not essential. These sub-projects are therefore of lower priority.

  • Tutorial - Your First Recording has screenshots of many types of connectors. Some text to explain what the differences are and how they are used would be nice, possibly a new page. There is some text already on the main Audacity wiki about this - we want to avoid duplicated effort, so we need to decide whether such text lives there or here.
  • There are tutorials linked to from the Old Pages page, which are in an old style. They're not linked to from the Main Page. We need to decide which of these are already sufficiently covered by Dominic's new tutorials, and which need updating.
  • Do we want to add an 'effects' section on the Main Page? I don't think we'll document all the effects and their parameters in time for 1.4.0. Should we even try to have some? NB: Potentially we could generate screenshots of all effects and their parameters automatically, but not in the 1.4.0 timescale.