Cytoscape Wiki
Prepare Documentation
Overview
Your app is ready for use! Now you need documentation. Effective user documentation is crucial for making your app accessible and useful to users. This step will outline some useful types of documentation and point to some examples.
Process
The first three of the below documentation resources are listed in a suggested order of priority, starting with user tutorials. The last three are independent. The most important type of documentation to prepare is tutorial-style instructions for basic use.
User tutorials
Having good user tutorials are crucial for getting users to actually use your app without problems. User tutorials should be written in the style of a workflow, describing the most common basic use cases. Additional or advanced use cases should be separated into separate tutorials.
Examples of User Tutorials
FAQs
User manual
Examples of User Manuals
Bug tracker
Technical documentation
Algorithms, methods, link to code etc