Category:Software Documentation Pages

From VrlWiki
Revision as of 17:08, 9 November 2008 by Jadrian Miles (talk | contribs) (New page: This is a super-category of categories of pages that serve as documentation for software we write. There are two types of documentation: '''user documentation''' and '''programmer documen...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This is a super-category of categories of pages that serve as documentation for software we write. There are two types of documentation: user documentation and programmer documentation.

User documentation for users of software that we write. The users of a GUI program are probably students, experiment subjects, or collaborators. The users of a command-line program or helper script are probably people within our own group who will use the program to do research. Every significant piece of software, whether it has a GUI or not, should have user documentation.

Programmer documentation is for programmers who would like to either modify source code we've written or use one of our libraries in their own code. Every significant piece of software, especially libraries, should have programmer documentation.

Subcategories

This category has the following 2 subcategories, out of 2 total.