Differences

This shows you the differences between two versions of the page.

--- dev:qt4_feature_review [2009/11/16 01:45]
michael
+++ dev:qt4_feature_review [2009/11/16 02:11]
michael
@@ Line 2: / Line 2: @@
 ====== Feature Review for Thorn ======
-This is intended to be complementary to the [[qt4_bug_tracker|Fake Bug Tracker]] -- it's an attempt to go through every feature in the program that has its own user interface space, such as a dialog or ruler, and decide how many of them are acceptable in layout and basic function and how many could do with some more work on the interfaces.  Real behavioural problems should go in the tracker, not here.
+This is intended to be complementary to the [[qt4_bug_tracker|Fake Bug Tracker]].
+**NOTICE** DISREGARD ALL OF THIS FOR THE TIME BEING.  I have been thinking about what I started here, and before this gets too far out of hand, I'm going to go through here and refactor it, and all the instructions I wrote 10 minutes ago are null and void now.
+We'll do one page per major editor (what was H2 in the original) and we won't go in reverse order.  I'm going to flip all of that crap around before I go any further.
+What we're going to wind up with is a systematic and formatted list of all menu functions with review comments inline.  It's no far stretch to take that work, polish it up a little here and there, and turn the whole shebang into the beginning of a new **manual** from scratch, that won't leave anything out.  We can pull bits from the old manual into the new structure, and add copy to fill in all the holes (the original manual had a ton of comments about things that never ultimately got documented) and eventually wind up with a good piece of documentation out of all of this.  Of course I don't expect that to get done before February, but it's pointless to type all this crap without an eye toward getting the biggest long-term return.
+Stay tuned...
+This was a good idea Chris had, but I'm starting over from the top and being more systematic and methodical.  Because I have a tendency to use the menu options on the left more than those on the right of any particular context, the methodology is to go from right to left, bottom to top.  When menu items appear in related pairs or groups, eg. "move to staff above" and "move to staff below" it is OK to glob them all together in one section unless particular of them have problems.  If all of this seems confusing, a look below should make it apparent enough.
+The TOC in this document doesn't like having major editors as H1 headings, so I had to adjust everything to make the TOC sensible.
+<code docuwiki>
+===== Major Editor (eg. Notation, Main Window) =====
+==== Top Level Menu ====
+=== Menu Item ===
+== Menu Sub-Item ==
+**Menu Sub-Sub-Item** (not enough levels of headings to make that work out)
+</code>
+While going through the interface, bugs are noted as **BUG** inline in the comments.  These should be collected and copied to the
+[[qt4_bug_tracker|bug tracker]] page.  It is acceptable to wait and copy them straight to the "bugs now fixed" section at the bottom if they are trivial bugs to hammer out.
+As one thing leads to another, major sub-features like the guitar chord editor, the control rulers, and so forth will get their own H2 level sections with links from the relevant sections in the menu item by item documentation.
+This is going to be a huge pain in the ass to finish and do as well as what I've restarted here in the Notation section below.  Seems like maybe Julie, Chris and Ilan are all anal retentive enough to help out with this and be thorough and methodical enough to make it worthwhile.  Any takers?  We could divide up and work on different sections in the same fashion as what I've begun here.  Then somebody could go back through and pull out all the **BUG** notices.