maemo.org Bugzilla – Bug 3803
How To information incomplete and not helpful
Last modified: 2008-12-30 11:32:32 UTC
You need to log in before you can comment on or make changes to this bug.
SOFTWARE VERSION: (Control Panel > General > About product) STEPS TO REPRODUCE THE PROBLEM: Visit http://maemo.org/development/documentation/how-tos/ EXPECTED OUTCOME: Helpful information on how to achieve specific results ACTUAL OUTCOME: Useless page describing Maemo releases in incomprehensible form using release versions. Points to the documentation index, none of which is "how to" information. It appears that the separation of the OS and the applications should also be addressed at some point. This seems to be a web site for people who already know what they are doing with Maemo, but there are no pointers to information for beginners. REPRODUCIBILITY: always EXTRA SOFTWARE INSTALLED: OTHER COMMENTS: User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US; rv:1.9.0.3) Gecko/2008092417 Firefox/3.0.3
Not a bug about the wiki at all, hence reassigning. > EXPECTED OUTCOME: > Helpful information on how to achieve specific results And that's way too unspecific too make this a valid report. :-/ Please elaborate your exact expectations, otherwise I have no idea how to "fix" this bug. The page links to http://maemo.org/maemo_release_documentation/maemo4.1.x/ - what is missing?
The old HOWTOs are still there: http://maemo.org/development/documentation/how-tos/4-0-x/ They are mostly not release dependent, which is another reason to move away from the "release number/type of documentation" structure, but some will probably need updating. Many could probably benefit from being put in the wiki, and dropping this section altogether. This is part of the content reorganisation which will happen with the front page redesign - this kind of documentation will end up in the "Get help" or "Support" section of the site.
Moving Documentation component from maemo.org to Development Platform since the bugs there refer to official developer documentation and this falls out of the responsibility of the community. Sorry for the noise, you can filter your bugmail by searching for this comment.
Changed Severity to enhancement and target milestone to Fremantle. Current maemo.org has usability problems that it is very difficult to find anything from the site :). I just copy this item below from my todo list for maemo.org as proposal for new spec: mameo.org usability issues - current structure of site does not allow user to see what maemo release specific documentation is available in maemo.org without going through the whole menu structure - enable easy access to all maemo release specific documentation with new release specific summary pages - release info pages include basic release info and links to all release specific documentation - get rid of current site structure where user has to first choose (or quess) what type of document he needs to read (API doc, how-to, training material, ...) and then choose for which maemo release that needs to be done (2.2, 3.x, 4.0.x 4.1.x, ..) - instead change maemo.org site structure to support easy access for maemo release specific documentation (maemo release summary pages) - instead change maemo.org site structure to support easy access for maemo technology area specific documentation (maemo technology summary pages) - review maemo.org front page to better support easy access to maemo.org services and site sections for the latest maemo version (e.g. to the latest SDK release, documents, search, wiki, bugzilla, planet, garage, mailing lists, repositories, lxr, ...) - add site map page (information and links to maemo.org pages and sections on one page) - maemo mailing lists - IRC channels - RSS feeds - repositories available and their usage - bugzilla, wiki, planet, etc - external maemo related sites - most important open source projects maemo uses/hosts
I would suggest setting lower, more practical, short range goals: 1. Survey available documentation/howto/reference pages. 2. Create a SINGLE easily navigated page with all the documentation for the latest release (4.1 and whatever parts of 4.0 still apply). 3. Create similar SINGULAR pages for each older release we have got the documentation for. These goals are easier to achieve, do not really rely on Fremantle, and will be of immediate help to developers.
Please, refer to the "Development" section of the mockup at http://fms.komkon.org/MaemoMain.html This is how I see the single-point documentation page.
This is FIXED now. HowTo section has didappeared (it was already deprecated when this report was filed) and all the documentation should be clearer now: http://maemo.org/development/documentation/
(In reply to comment #7) > This is FIXED now. > HowTo section has didappeared (it was already deprecated when this report was > filed) and all the documentation should be clearer now: > http://maemo.org/development/documentation/ Actually, this current layout is still pretty messed up and requires a lot of clicking around to find required information. IMHO, it really needs a reorganization with less respect to the maemo.org standard page styling (i.e. menu on the right, hierarchical content on the left) and more respect to the ease of locating info.
(In reply to comment #8) > (In reply to comment #7) > > This is FIXED now. > > HowTo section has didappeared (it was already deprecated when this report was > > filed) and all the documentation should be clearer now: > > http://maemo.org/development/documentation/ > Actually, this current layout is still pretty messed up and requires a lot of > clicking around to find required information. IMHO, it really needs a > reorganization with less respect to the maemo.org standard page styling (i.e. > menu on the right, hierarchical content on the left) and more respect to the > ease of locating info. You might want to follow Bug 3931
Reopened this bug as original report is for restructuring maemo.org site for better usability (usable also for others than familiar with the current site structure). Somewhat missleading title (as we do not have how-to documents anymore but Maemo Reference Manual) changed to cover maemo.org site restructuring. Original title was "How To information incomplete and not helpful".
Also product changed from documentation to Website/general.
Jarmo, the initial report is all about http://maemo.org/development/documentation/how-tos/ Resolving as FIXED again. "Restructuring maemo.org site for better usability" is too vague for an enhancement request anyway.
I created new bug 3972 for maemo.org usability improvement so this can be closed.