
Hi,
What are your feelings about documentation of Inkscape? Do you think we still need an official user guide that would be available from our main website just like tutorials (in multiple langauges)?
I'm kinda worried about it, because 0.46 will introduce practically all possible SVG filters and there is just no user friendly documentation on them, at least in English (yes, even books on Adobe Illustrator I've seen do not cover them in any decent way, and W3C spec is way too "technical").
Currently we have some ongoing work in French version of the user guide and not much of it in the English version:
http://inkscape.svn.sourceforge.net/viewvc/inkscape/user_manual/trunk/
Despite of it the situation isn't so bad, IMO. We have pretty detailed release notes that cover a lot of functionality. We could make at least good EN and FR user guides for upcoming 0.46.
What I suggest is trying to do it in small steps:
1. Add both EN and FR user guides to main website in same way we add tutorials. 2. Make them updatable in same way we updated tutorials. 2. Sync them content-wise. 3. Add missing parts borrowing from release notes where required.
This will raise some public interest and, hopefully, attract people willing to contribute (especially if we provide detailed description, how to do it, and define a place where people can meet and talk about docs). Then we can see if we can keep at least EN and FR versions in sync, which, when successful, will be a lot better than no (visible) official user guide at all.
What do you think?
Alexandre

lo Alexander
Hi,
What are your feelings about documentation of Inkscape? Do you think we still need an official user guide that would be available from our main website just like tutorials (in multiple langauges)?
It has been mentioned several times, but never done. I guess nobody has time for that. Bryce has already tried to put a drupal somewhere, but nobody really used it.
I'm kinda worried about it, because 0.46 will introduce practically all possible SVG filters and there is just no user friendly documentation on them, at least in English (yes, even books on Adobe Illustrator I've seen do not cover them in any decent way, and W3C spec is way too "technical").
I'm also worried. I would like to document the filters but it seems i won't have no time until november, at least. And in fact, i would do it well (i hope) for french but my english is so poor taht i just usually use the Release Notes as a basis for he EN version.
Currently we have some ongoing work in French version of the user guide and not much of it in the English version:
We now have a real team for french : With yemanja also writing and some proof-reader. I guess it would be nice if french inkscape user could find the documentation on the official inkscape website instead of coming to mine (at least it is giving me visitors ;) )
What I suggest is trying to do it in small steps:
- Add both EN and FR user guides to main website in same way we add tutorials.
- Make them updatable in same way we updated tutorials.
- Sync them content-wise.
- Add missing parts borrowing from release notes where required.
the more consistent it is the better. I've to check the way tutorials are updated. We were willing to switch to xml2po, but if there is another solution ...
This will raise some public interest and, hopefully, attract people willing to contribute (especially if we provide detailed description, how to do it, and define a place where people can meet and talk about docs). Then we can see if we can keep at least EN and FR versions in sync, which, when successful, will be a lot better than no (visible) official user guide at all.
My opinion is that Tav's manual is nice but i can't see the licence (may be i have to search more). But "foreign" should be able to get a manual in their language . If the SVN-manual is more visible, sure that other people will want to contribute to it.
pygmee

On 9/16/07, radar.map35 wrote:
We now have a real team for french : With yemanja also writing and some proof-reader. I guess it would be nice if french inkscape user could find the documentation on the official inkscape website instead of coming to mine (at least it is giving me visitors ;) )
So, let's hit two closest targets:
1. Make both EN and FR version avalable form web-site 2. Start syncing them.
Colin, are you still around? :)
Alexandre

"Alexandre Prokoudine" <alexandre.prokoudine@...400...> writes:
On 9/16/07, radar.map35 wrote:
We now have a real team for french : With yemanja also writing and some proof-reader. I guess it would be nice if french inkscape user could find the documentation on the official inkscape website instead of coming to mine (at least it is giving me visitors ;) )
So, let's hit two closest targets:
- Make both EN and FR version avalable form web-site
They are linked already, should we also host them?
Colin, are you still around? :)
Not as much as before, but yes :)
Cheers Colin

On 9/18/07, Colin Marquardt wrote:
- Make both EN and FR version avalable form web-site
They are linked already,
Are you sure? I only see a link to User Guide by Kevin Wixson .
should we also host them?
Yes :)
Thanks to Bryce we now have a mailing list: https://lists.sourceforge.net/lists/listinfo/inkscape-docs
Alexandre

"Alexandre Prokoudine" <alexandre.prokoudine@...400...> writes:
On 9/18/07, Colin Marquardt wrote:
- Make both EN and FR version avalable form web-site
They are linked already,
Are you sure? I only see a link to User Guide by Kevin Wixson .
Oh. I must misremember then.
should we also host them?
Yes :)
So I guess we should first figure out how we want to do that. If we want to ship them with Inkscape, the rendered output should probably be in the inkscape module.
Thanks to Bryce we now have a mailing list: https://lists.sourceforge.net/lists/listinfo/inkscape-docs
I subscribed it to Gmane and will read it from there once it's set up on their part.
Cheers Colin
participants (3)
-
Alexandre Prokoudine
-
Colin Marquardt
-
radar.map35@...8...