Talk:Development documentation

From ElphelWiki
Jump to: navigation, search

Ilya, I've got somewhat lost when you rearranged material.

First of all I prefer clear division between user and developer documentation. For example "software" in the main menu should relate to the software that camera users are using, not the future software projects and ideas.

Second I prefer to have longer multi-section (so individually editable) scrollable pages with automatic "Contents" above, not small pages where you need to click and click back to get to somewhere. When the article will grow really big to scroll - then we can split the page in several.

So why did you split the "Roadmap" into smaller ones? Thinking that each section will eventually grow too big? Or big pages load slow through the dialup? Or something else?

The "Background" section I wrote for developers, not for the general "Software" section.

So, my early experience in translating the help files ;) One theme - one page. It's more usability. But you right - the documentation for "user" and "developer" must be different.

I remove "Background" to the first place.

And still. Now the all new texts about developing. I think, I can move it to "stable" section later? After editing?


I just looked at how articles at Wikipadia look like. Automatic contents at the top seem useful and I liuke using sections/subestions until the page will grow too big. As for moving develope pages to "stable" - I didn't understand exactly what do you mean. There always will be user documentation and developer documentation and developer documentation is not "unstable" version of the user one. When some project will be ready for the users - we will have to write te user docs. But developer's pages are not secret so users can browse there too if they like.

"Stable" version of Manual, as I think, is version for cameras Live-CD for the end camera users. In the Wiki may be many texts, comments, discusses, etc. But in the Cameras Manual that not needed. The Cameras Manual must be the really finished and must include the finished articles. Ilya

Sure manual is what will be distrubuted with (and in) the camera. First it will be edited here in wiki - just separately from the developers pages.

I hope, the "edition" will not transformed to "discussion" ;)

Otherwise, the preparing of "stable" Cameras Manual can be very difficult work.



Documentation for the camera is not the only purpose of this Wiki - it is just one of the projects. This is why I would rather see them clearly separated on the very top. It will also simplify converting user documentation branch into static version to be included with the camera.

We can just put a two-item menu on the main page to Roadmap and User Documentation.

And don't be afraid of discussion - it is already separate from the articles.


So, I replace the Main Page.