Start here
Posted on 2007-02-12 12:33:17 EET.
Just two days ago I wrote about being confused when I tried to follow Maemo documentation. I looked at other websites addressed for end users and developers and noticed that Maemo is not the only one which provides unlogic navigation. Also Midgard ( the one I write docs for ) project website needs more love.
This would be cool IMO:
"Get started" section with:
What would you like to do.
- I have device XXX and I want to install new applications
- Where...
How ...
I have device XXX and I want to update OS I have installed
- Where ...
How ...
I am a developer and I want to write new application
- How to start ?
- What should I install on my device?
- When and why do I need SDK on my device ?
Features
- What is ...
- How ...
- Why ...
The main point here ( and everywhere ) must be to treat everyone as a user. Even a developer. A developer is only a human and should have a good place where can start. It's not funny anyway when you prepare for hacking but first you must hack docs and notes.
A cool feature for any website with documentation would be possibility to bookmark resources the same way how you can add products to cart in any online shop. Once you like the website you can customize your start page and limit information only to this you are really interested in.
Probably I could contribute and write some simple howtos for maemo. But the real problem is the fact that the more I read docs the more I am confused. There are plenty of "how to ..." but at the same time there is almost nothing about why and when.
Example. There is quite long and "almost with details" how to create custom rootfs for device doc. But there's nothing about why do I need custom rootfs and why should I use it instead of downloadable and installable, ready to use SDK rootfs. What is more , I couldn't find any info why do I have to install rootfs SDK on my device :)