Jump to content

QA/BSA/TODO: Difference between revisions

From The Document Foundation Wiki
< QA | BSA
RBd (talk | contribs)
mockup
Loic (talk | contribs)
In the draft implementation the page is cleared and the link to the bug report shown at the top of the page. If you have scrolled down as a result of filling the form, you miss the link that's on top.
(7 intermediate revisions by the same user not shown)
Line 14: Line 14:
== ToDo ==
== ToDo ==
=== Troubleshooting ===
=== Troubleshooting ===
* {{fdo|40770}} -- [[User:RBd|Rainer Bielefeld]] 2011-09-13T11:55:00 (CEST)
* <s>I successfully filed {{fdo|40821}}, but after "Submit" a blank screen remained, not bug report appeared --</s> [[User:RBd|Rainer Bielefeld]] 2011-09-13T11:55:00 (CEST)
* I successfully filed {{fdo|40821}}, but after "Submit" a blank screen remained, not bug report appeared -- [[User:RBd|Rainer Bielefeld]] 2011-09-13T11:55:00 (CEST)


=== Issues ===
=== Issues ===
* on [[Bug Submission Assistant]] the "[http://libreoffice.org/get-help/bug/ official entry point]" shows "Sorry, the page you tried to visit was not found." -- [[User:RBd|Rainer Bielefeld]] 2011-09-14T09:54:22 (CEST)
* on [[Bug Submission Assistant]] the "[http://libreoffice.org/get-help/bug/ official entry point]" shows "Sorry, the page you tried to visit was not found." because someone has to decide to publish said page in silverstripe. -- [[User:RBd|Rainer Bielefeld]] 2011-09-14T09:54:22 (CEST)
* We need a checkbox "Want to report a request for new Feature or Enhancement?" (Severity-Selector to "Enhancement") -- [[User:RBd|Rainer Bielefeld]] 2011-09-13T12:58:39 (CEST)
* We need a checkbox "Want to report a request for new Feature or Enhancement?" (Severity-Selector to "Enhancement") -- [[User:RBd|Rainer Bielefeld]] 2011-09-13T12:58:39 (CEST)
* Submit - link: Mouseover does not change mouse pointer view
* Submit - link: Mouseover does not change mouse pointer view
* Reporter should be encouraged to select a ''Subcomponent'', what will ease queries very much. But it's not mandatory, we only have subcomponents for most of bug types, not for all. Currently you can't continue in the Assistant without a selected Subcomponent, so we need an additional seelction ''none'' or similar, what will not add any key word to the subject line, but allow to continue. Related selectoin on [[BugReport_Details]] always is "for all other problems". -- [[User:RBd|Rainer Bielefeld]] 2011-09-10T19:42:42 (CEST)
* <s>Reporter should be encouraged to select a ''Subcomponent'', what will ease queries very much. But it's not mandatory, we only have subcomponents for most of bug types, not for all. Currently you can't continue in the Assistant without a selected Subcomponent, so we need an additional seelction ''none'' or similar, what will not add any key word to the subject line, but allow to continue. Related selectoin on [[BugReport_Details]] always is "for all other problems".</s> -- [[User:RBd|Rainer Bielefeld]] 2011-09-10T19:42:42 (CEST)
* Currently '''Version unspecified''' is missing in the picker. But this "version" is required for several bug types what are not inevitably related to LibO versions (WWW, Extensions, Linguistic), so this "Version" ''unspecified'' has to be introduced. -- [[User:RBd|Rainer Bielefeld]] 2011-09-10T19:35:42 (CEST)
* <s>Currently '''Version unspecified''' is missing in the picker. But this "version" is required for several bug types what are not inevitably related to LibO versions (WWW, Extensions, Linguistic), so this "Version" ''unspecified'' has to be introduced.</s> -- [[User:RBd|Rainer Bielefeld]] 2011-09-10T19:35:42 (CEST)
* Latest modification in the Component Help Template design (shifting "Read more" into the Help text, see [http://wiki.documentfoundation.org/index.php?title=Template:BugzAssHlp_Chart&diff=next&oldid=35812 Chart]) is comfortable for the Assistant (No additional link creation required), but result is bad, "Read more" now also is shown in  [[BugzAssHlp_Chart_long|long help text]]. Solutions: Solution how to suppress in long help text, return to old microformat, ...? -- [[User:RBd|Rainer Bielefeld]] 2011-09-10T10:17:41 (CEST)
* Latest modification in the Component Help Template design (shifting "Read more" into the Help text, see [http://wiki.documentfoundation.org/index.php?title=Template:BugzAssHlp_Chart&diff=next&oldid=35812 Chart]) is comfortable for the Assistant (No additional link creation required), but result is bad, "Read more" now also is shown in  [[BugzAssHlp_Chart_long|long help text]]. Solutions: Solution how to suppress in long help text, return to old microformat, ...? -- [[User:RBd|Rainer Bielefeld]] 2011-09-10T10:17:41 (CEST)
* <s>Component selector also can be moved up/down using arrow keys (that's good), but Help text does not follow the selection (not good).-- [[User:RBd|Rainer Bielefeld]] 2011-09-05T19:54:08 (CEST)</s> seems repaired, -- [[User:RBd|Rainer Bielefeld]] 2011-09-08T18:38:12 (CEST)
* <s>Component selector also can be moved up/down using arrow keys (that's good), but Help text does not follow the selection (not good).-- [[User:RBd|Rainer Bielefeld]] 2011-09-05T19:54:08 (CEST)</s> seems repaired, -- [[User:RBd|Rainer Bielefeld]] 2011-09-08T18:38:12 (CEST)
Line 29: Line 28:
* Help texts for all Components listed on [[BugReport Details]] will have to be adapted by creation for short text template and elaborated help text due to Help for CHART (please add Template link for dones): <s>[[Template:BugzAssHlp_BASIC|BASIC]], [[Template:BugzAssHlp_Chart|Chart]] / [[BugzAssHlp_Chart_long]], [[Template:BugzAssHlp_contrib|contrib]]</s>, <s>[[Template:BugzAssHlp_Database|Database]]</s>, <s>[[Template:BugzAssHlp_Documentation]]</s>, <s>[[Template:BugzAssHlp_Drawing|Drawing]], [[Template:BugzAssHlp_Extensions|Extensions]], [[Template:BugzAssHlp_Formula editor|Formula&nbsp;editor]],</s>,  Installation, Libreoffice, Linguistic component, Localization, <s>[[Template:BugzAssHlp_PDF_export]]</s>, Presentation, Spreadsheet, UI,  WRITER, <s>[[Template:BugzAssHlp WWW]]</s>
* Help texts for all Components listed on [[BugReport Details]] will have to be adapted by creation for short text template and elaborated help text due to Help for CHART (please add Template link for dones): <s>[[Template:BugzAssHlp_BASIC|BASIC]], [[Template:BugzAssHlp_Chart|Chart]] / [[BugzAssHlp_Chart_long]], [[Template:BugzAssHlp_contrib|contrib]]</s>, <s>[[Template:BugzAssHlp_Database|Database]]</s>, <s>[[Template:BugzAssHlp_Documentation]]</s>, <s>[[Template:BugzAssHlp_Drawing|Drawing]], [[Template:BugzAssHlp_Extensions|Extensions]], [[Template:BugzAssHlp_Formula editor|Formula&nbsp;editor]],</s>,  Installation, Libreoffice, Linguistic component, Localization, <s>[[Template:BugzAssHlp_PDF_export]]</s>, Presentation, Spreadsheet, UI,  WRITER, <s>[[Template:BugzAssHlp WWW]]</s>
** If you find problems with the templates in Wiki or Assistant, please add hints how to avoied here!
** If you find problems with the templates in Wiki or Assistant, please add hints how to avoied here!
* Assistant should not send any default selections to Bugzilla. Help Text should recommend to select, but if selector remains in position "choose", Assistant will send an explicit "not selected " to Bugzilla (like ";version=?"). -- [[User:RBd|Rainer Bielefeld]] 2011-09-05T20:08:21 (CEST)
* <s>Assistant should not send any default selections to Bugzilla. Help Text should recommend to select, but if selector remains in position "choose", Assistant will send an explicit "not selected " to Bugzilla (like ";version=?").</s> -- [[User:RBd|Rainer Bielefeld]] 2011-09-05T20:08:21 (CEST)
* Get a mockup of the bug assistant page so that it can be integrated with https://freedesktop.dachary.org/libreoffice/bug/bug.html  
* <s>Get a mockup of the bug assistant page so that it can be integrated with https://freedesktop.dachary.org/libreoffice/bug/bug.html</s>
* Define steps and sort order for items of Assistant, the user has to pass some pages, on each he has to  click check boxes or  radio buttons until all information has been  gathered and a check  Concerning DUPs has been done. Details have to be  added
* Define steps and sort order for items of Assistant, the user has to pass some pages, on each he has to  click check boxes or  radio buttons until all information has been  gathered and a check  Concerning DUPs has been done. Details have to be  added
* Help User to find the correct Version and appropriate Subcomponent  
* Help User to find the correct Version and appropriate Subcomponent  
* A Manual has to be written. Less for the users, UI should be self explaining, but for programming team to keep overview
* <s>A Manual has to be written. Less for the users, UI should be self explaining, but for programming team to keep overview</s>
* Page with forward is active. Forward currently should be to [https://bugs.freedesktop.org/enter_bug.cgi?product=LibreOffice;bug_status=UNCONFIRMED;version=? here], may be after 3 seconds and with a link to the current draft (may be you want to test ...)
* Page with forward is active. Forward currently should be to [https://bugs.freedesktop.org/enter_bug.cgi?product=LibreOffice;bug_status=UNCONFIRMED;version=? here], may be after 3 seconds and with a link to the current draft (may be you want to test ...)
** Thx, where can I find / what is the URL of the forward? -- [[User:RBd|Rainer Bielefeld]] 2011-09-13T14:21:00 (CEST)
** Thx, where can I find / what is the URL of the forward? -- [[User:RBd|Rainer Bielefeld]] 2011-09-13T14:21:00 (CEST)

Revision as of 13:51, 14 September 2011

This page should be used to collect ideas and information concerning the Bug Submmission Assistant. For other project related ToDos please use QA-Projects-Incubator#Bug_Submission_Assistant

Next Things To Be Done

Draft, to be completed by project members.

Most important on top

  1. Input selector for Operating System -- Rainer Bielefeld 2011-09-14T14:10:33 (CEST)
  2. Someone has to define a Wiki Help text document for Subcomponents (separate document, structure similar to Components part of BugReport_Details) and for other, more Assistant related Help (What Version should be selected, how and what Attach, ... also separate document, structure similar to Components part of BugReport_Details). Templates (as used for Components) can be created later. As long as these Documents are without useful contents, Subcomponent explications should simply contain a (headings) list with known subcomponents, someone can fill that later. Other Help only contains a texts list with Help Numbers (Help001 ... Help999, invisible in Assistant) and Help texts (Help001 ... Help999, visible at it's place in the Assistant. Someone can fill that later. Until we have no real contents, the Help number texts will be shown. Loic defines the details to be mentioned. A general "Read more" function might be use, but should work better than the one from Components.-- Rainer Bielefeld 2011-09-14T14:10:33 (CEST)
  3. Decision how Subcomponent Help will be made available. --Rainer Bielefeld 2011-09-14T14:18:23 (CEST)
  4. Idea draft for Search links "behind" the Subcomponent names
    If we want to leave the additional Search links "behind" the Subcomponent names in the Component descriptions (what has some advantages, query can be modified to users needs) that has to be explained by a help text. -- Rainer Bielefeld 2011-09-14T14:23:08 (CEST)
  5. Eliminating malfunctions as listed under ToDo-- Rainer Bielefeld 2011-09-14T14:10:33 (CEST)

ToDo

Troubleshooting

  • I successfully filed fdo#40821, but after "Submit" a blank screen remained, not bug report appeared -- Rainer Bielefeld 2011-09-13T11:55:00 (CEST)

Issues

  • on Bug Submission Assistant the "official entry point" shows "Sorry, the page you tried to visit was not found." because someone has to decide to publish said page in silverstripe. -- Rainer Bielefeld 2011-09-14T09:54:22 (CEST)
  • We need a checkbox "Want to report a request for new Feature or Enhancement?" (Severity-Selector to "Enhancement") -- Rainer Bielefeld 2011-09-13T12:58:39 (CEST)
  • Submit - link: Mouseover does not change mouse pointer view
  • Reporter should be encouraged to select a Subcomponent, what will ease queries very much. But it's not mandatory, we only have subcomponents for most of bug types, not for all. Currently you can't continue in the Assistant without a selected Subcomponent, so we need an additional seelction none or similar, what will not add any key word to the subject line, but allow to continue. Related selectoin on BugReport_Details always is "for all other problems". -- Rainer Bielefeld 2011-09-10T19:42:42 (CEST)
  • Currently Version unspecified is missing in the picker. But this "version" is required for several bug types what are not inevitably related to LibO versions (WWW, Extensions, Linguistic), so this "Version" unspecified has to be introduced. -- Rainer Bielefeld 2011-09-10T19:35:42 (CEST)
  • Latest modification in the Component Help Template design (shifting "Read more" into the Help text, see Chart) is comfortable for the Assistant (No additional link creation required), but result is bad, "Read more" now also is shown in long help text. Solutions: Solution how to suppress in long help text, return to old microformat, ...? -- Rainer Bielefeld 2011-09-10T10:17:41 (CEST)
  • Component selector also can be moved up/down using arrow keys (that's good), but Help text does not follow the selection (not good).-- Rainer Bielefeld 2011-09-05T19:54:08 (CEST) seems repaired, -- Rainer Bielefeld 2011-09-08T18:38:12 (CEST)

Everything else

  • Help texts for all Components listed on BugReport Details will have to be adapted by creation for short text template and elaborated help text due to Help for CHART (please add Template link for dones): BASIC, Chart / BugzAssHlp_Chart_long, contrib, Database, Template:BugzAssHlp_Documentation, Drawing, Extensions, Formula editor,, Installation, Libreoffice, Linguistic component, Localization, Template:BugzAssHlp_PDF_export, Presentation, Spreadsheet, UI, WRITER, Template:BugzAssHlp WWW
    • If you find problems with the templates in Wiki or Assistant, please add hints how to avoied here!
  • Assistant should not send any default selections to Bugzilla. Help Text should recommend to select, but if selector remains in position "choose", Assistant will send an explicit "not selected " to Bugzilla (like ";version=?"). -- Rainer Bielefeld 2011-09-05T20:08:21 (CEST)
  • Get a mockup of the bug assistant page so that it can be integrated with https://freedesktop.dachary.org/libreoffice/bug/bug.html
  • Define steps and sort order for items of Assistant, the user has to pass some pages, on each he has to click check boxes or radio buttons until all information has been gathered and a check Concerning DUPs has been done. Details have to be added
  • Help User to find the correct Version and appropriate Subcomponent
  • A Manual has to be written. Less for the users, UI should be self explaining, but for programming team to keep overview
  • Page with forward is active. Forward currently should be to here, may be after 3 seconds and with a link to the current draft (may be you want to test ...)
    • Thx, where can I find / what is the URL of the forward? -- Rainer Bielefeld 2011-09-13T14:21:00 (CEST)

Web design

The Bug Submission Assistant is a form that a libreoffice user can fill when (s)he finds a bug. It is intended to be simple and user friendly. It needs a nice look so that the user is encouraged to contribute by spending a few minutes of her/his time to fill the form and submit a useful bug report. In the following screenshots, the behavior of the Bug Submission Assistant is explained. The layout of the elements (for instance the fact that the current step is being shown to the left) can be changed and are only placed there to demonstrate its functionalities. A live example is available, without the surrounding menus. It will be included within http://libreoffice.org/ using an iframe. The general idea is that the user is presented with a form which is progressively revealed to her/him so that it looks like a guide or a wizard instead of a large intimidating form with many fields.

Branding / Visual Resources

Step 0

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Deliverables

Ideas, definitions

Report Text

Detailed LibO Version Information

Milestone 0.3
Draft, Pulldowns not shown correctly

Create LibO + OS-Version String similar to the one in fdo#40821. Proposal: when User does his LibO version selection, an Input help (see mockup) appears, helps to collect data. For Milestone 0.2 We might contribute a sample for copy / paste and ask user to contribute a String similar to shown example)

Detailed Operating System Information

Milestone 0.3

Create LibO + OS-Version String similar to the one in fdo#40821. Proposal: when User does his OS selection, helps to collect data

Bugzilla Login

When the reporter reaches Bugzilla via assistant Bugzilla should recognize that the user already is logged in (if he is).

Bugzilla 4 Compatibility

We can't know when Freedesktop.org might update to Bugzilla 4. The design of the assistant should allow an easy update. Here you see how it looks Apache OOo Bugzilla (but the current Product - Component concept will probably remain)

Defaults

Defaults Bugzilla selections should be due to results of this link, Everything else should be added within the Assistant. For Milestone 0.2 Bug report text will be added in Bugzilla(?).

Short Help Texts

Similar to Bugzilla in the assistant short help texts should be available. That should be short texts (2-4 lines) like we have in Bugzilla, with a link to a more elaborated explication in the Wiki. It would be comfortable and flexible if the Assistant directly could use Wiki texts. Texts should be used from a Cache (a problem with the wiki should not interfere bug reporting, Updated from Wiki every few hours and may be if needed (for tests of modified tests it would be useful to be able to force the update).

Subcomponents

The current Bugzilla version does not support a category Subcomponent. So a pseudo - Subcomponent will be defined by a key word in the Subject line.

  • The Subcomponent selector should be context related to selected Component, only applicable Subcomponents should be listed.

Version Picker

The picker should show Versions in "natural sort order": Beta1 ... Beta5, RC1 ... RC5, Release. Exclusion: Daily and Master Build should always be the last ones in the picker. Exclude LibO versions older than 1 year (or similar) from selection, that will keep assistant more well arranged.

Ideas

  1. LibO version sniffer
  2. OS sniffer
  3. Sniffer for available LibO versions on bugzilla adding them to Assistant.
  4. Common Help text base for Wiki, Bugzilla, Assistant
  5. Search for DUPs in OOo Bugzilla (might be interesting until end of 2012)
  6. Key word index
  7. Localized versions (something for milestone 0.4 or later): The frontend is available in several / all languages, reporter can do the report in his language, a language related translator will be set to CC automatically. To make this possible without too many script modifications for each new language, a version of the assistant for "not English reports" with reduced reporter influence to settings (after language selection) should be available (details of will have to be discussed). It's planned (and in parts already done) to have Bug report details (Subcomponents) available in various languages in the Wiki. If we also use several Assistant UI (Help) texts from the Wiki, additional languages can be added and maintained without big expense.

Additional information

for Work items:

  1. Menu Item has to be integrated into LibO UI

Define steps and sort order for items of Assistant

Draft
  1. Greeting with max 4 lines introduction and a link for a complete Frontend manual (may be someone will want to know how many steps will be required and whether he will have to prepare something). Example here
  2. Select Component Example for a help text here
  3. Add Subcomponent available subcomponents should be extracted from Component Help text
  4. Ask for LibO version
  5. Ask for Libo Localization
  6. Ask for Operating Sytem, hint that additional info concerning Distribution, OS version, ... has to be integrated into Bug report text
  7. Add Additional Information
    1. Crash?
    2. Document related?
    3. .
  8. Start Query for DUP search (link similar to clicking a Subcomponent on BugReport_Details
  9. Activate "Submit" button

Additional ideas for assistant functions you find on http://lists.freedesktop.org/archives/libreoffice/2011-February/008254.html and other postings from that thread. They should be integrated here and on Bug Submission Assistant