Next: , Up: Contributing to Marsyas


1.1 Contributing documentation

The documentation for Marsyas is still a work in progress; we can use all the help we can get. Don't say “oh, I don't know enough” or “I'm not good at writing English.” The question is not “could anybody create something better than my suggestion?” – the question is “is this better than nothing?” Remember the most important thing about documentation:

Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing. (Dick Brandon)

1.1.1 Manual

If you can add something to the docs, please send an email to <marsyas-developers@lists.sourceforge.net>. A formal patch for the texidoc is not required; we can take care of the technical details. Here is an example of a perfect documentation suggestion:

To: marsyas-users@lists.sourceforge.net
From: helpful-user@example.net
Subject: doc addition

In 4.2.1 Implicit patching vs. explicit patching, please add
----
It could be helpful to think of this like blah blah blah.
----
to the second paragraph.

1.1.2 Examples

Small, easy-to-understand examples are also great. If you have some source code that illustrates something, we can add it to examples/. We use these examples to generate the Example programs. You don't have to write any English at all!