ToDo

From Audacity Development Manual
Revision as of 19:51, 5 January 2008 by Windinthew (talk | contribs) (Updates for things already done)
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...

  • Keyboard Shortcut Reference looks a major task, inserting all the current shortcuts, categorizing and explaining them, and making it look decent.
  • Timeline needs a simple one sentence explanation that there is also a vertical ruler in a most track views and what it does.
  • Index?? Let's get the talk page for it and discuss what we want.
  • Images needed: Toolbars needs an image of docking with a blue triangle. Edit Toolbar - James plans to upload backgroundless images.
  • Image updates: Pencil image on Tools Toolbar needs white background.
  • Audio CDs need to get text from other wiki and rejig??

Some details

  • Old text on Mixer Toolbar probably needs more reworking.
  • Import / Export Preferences needs text for "Show Metadata Editor" in the event this box is changed to affect non-chain exports. Otherwise, move it from here to Interface Preferences
  • All other Preferences images need updating as the tab order has changed.

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.
  • Post 1.4.0, generate screenshots of all effects and their parameters automatically, and probably have separate Manual pages for each.