How to author documentation

Gensim is a large project with a wide range of functionality. Unfortunately, not all of this functionality is documented well, and some of it is not documented at all. Without good documentation, users are unable to unlock Gensim's full potential. Therefore, authoring new documentation and improving existing documentation is of great value to the Gensim project.

If you implement new functionality in Gensim, please include helpful documentation. By "helpful", we mean that your documentation answers questions that Gensim users may have. For example:

• What is this new functionality?
• Why is it important?
• How is it relevant to Gensim?
• What can I do with it? What are some real-world applications?
• How do I use it to achieve those things?
• ... and others (if you can think of them, please add them here)

Before you author documentation, I suggest reading "What nobody tells you about documentation" or watching its accompanying video (or even both, if you're really keen).

The summary of the above presentation is: there are four distinct kinds of documentation, and you really need them all:

1. Tutorials
2. Howto guides
3. Explanations
4. References

Each kind has its own intended audience, purpose, and writing style. When you make a PR with new functionality, please consider authoring each kind of documentation. At the very least, you will (indirectly) author reference documentation through module, class and function docstrings.