[scribus-dev] Developer Handbook ideas

[Darius Blaszyk]

 There are infinite ways to create online handbooks. But to me it seems
that the quality of the content is much more important than anything
else. Scribus seems to be in heavy development now and therefore the
online manuals need to be adjusted regularly. What I noticed since I
started to use Scribus is that the wiki is not often making clear which
scribus version is being described and information is scattered and
incomplete. 

Blender is one of the best organized opensource projects that I know of
and has a very well organized team. They do work with module owners
(http://wiki.blender.org/index.php/Dev:Doc/Process/Module_Owners/List)
[3]. [4] Perhaps this would be a good idea for Scribus as well to adopt
this way of working? I think informally scribus is already working like
beacause each developer has it's own field of interest but are all areas
covered properly? Being a module owner also does not mean that all
issues related to the module are solved or handled by that person. A
module owner is formally nothing more than a "mentor" that keeps an eye
out to ensure quality is met. Although assigning module owners will not
enforce up to date documentation (or other parts of the project), it
will however help to organize the teams in focusing on what needs to be
done. Another good feature in the blender documentation was the use of
namespaces. Starting from blender 2.4 they introduced a new wiki for 2.5
and 2.6, this was very useful when the software still was in great flux.
Starting from 2.7 however blender has switched (they are still in the
process of switching) to just one system based on _reStructuredText_.
Campbell Barton wrote a script to migrate all the existing wiki contents
to the new markup language
(http://blender.org/manual/about/migration.html). As described in the
manual each system has it s pro's and cons. To me it really does not
matter too much if you use a wiki, reStructuredText or even an
openoffice document, as long as the documentation covers all aspects of
the software (if if it's incomplete in some parts) and that it's up to
date.

Some more links on the blender documentation project.
http://www.blender.org/documentation/
http://blender.org/manual/ [5]
https://github.com/ideasman42/blender_manual [6]

Darius

Kunda Loves Scribus schreef op 29 mrt '15: 

> FYI, I like the way musescore set up theirs: http://musescore.org/en/developers-handbook [1]
> 
> /Kunda 
> 
> _______________________________________________
> scribus-dev mailing list
> scribus-dev at lists.scribus.net
> http://lists.scribus.net/mailman/listinfo/scribus-dev [2]
 

Links:
------
[1] http://musescore.org/en/developers-handbook
[2] http://lists.scribus.net/mailman/listinfo/scribus-dev
[3]
http://wiki.blender.org/index.php/Dev:Doc/Process/Module_Owners/List)
[4] http://wiki.blender.org/index.php/Dev:Doc/Process/Module_Owners/List
[5] http://blender.org/manual/
[6] https://github.com/ideasman42/blender_manual
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.scribus.net/pipermail/scribus-dev/attachments/20150330/cb126e63/attachment.html>