Mailinglist Archive: opensuse-project (441 mails)

["Administrator" <admin@xxxxxxxxxxxxxxxxxxxxxxxxxx>]

> The problem for guys that have to write documentation is that
> developmet has
> to be frozen for a while, so that they can document changes. It is
> often far
> faster do create feature, then to document it. Programming languages
> are
> meant to be compressed expression, understandable to people with some
> training, while documentation has to explain that to people without it.
>
> What this will allow to openSUSE enthusiasts?
> Being knowledgable, leading community members.
> Lesser explanations online, just point to document.

An alternative would be to create a simple and unified method documenting 
features that doesn't take up much time and effort for the developers - and 
preferably one that enhances the process of development.  The problem will be 
creating one that integrates well with the development environments so that, 
for example, it is simple to document parameters to programmes or input 
dialogue boxes, and this documentation travels through the development process 
with the code.  If that is combined with the "requirements" documentation (this 
feature has been added / changed to answer this problem or requirement), it 
gives a very good start.  Converting mailing lists / discussion fora into 
useful documentation would also be made easier by suitable (open source) tools, 
and many people would be happy adding to such documentation (and responding to 
the question with a link) rather than repeatedly answering the "How do I ..." 
questions?

This is an area where organisations like openSUSE and Novell are in a stronger 
position to respond than the general community, which tends to have much 
shorter term timescales and more limited objectives.

David


--
To unsubscribe, e-mail: opensuse-project+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: opensuse-project+help@xxxxxxxxxxxx