Category:User Documentation: Difference between revisions

From VrlWiki
Jump to navigation Jump to search
Jadrian Miles (talk | contribs)
New page: This category is for pages that serve as documentation for ''users'' of software that we write. The users of a GUI program are probably students, experiment subjects, or collaborators. T...
 
Jadrian Miles (talk | contribs)
No edit summary
 
Line 1: Line 1:
This category is for pages that serve as 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.
This category is for pages that serve as 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.


The titles of user documentation pages should be in the form "<ProgramName>/user documentation".  Every significant piece of software, whether it has a GUI or not, should have user documentation.  {{addcategory|{{PAGENAME}}}}
The titles of user documentation pages should be in the form "<Program Name>/user documentation".  Every significant piece of software, whether it has a GUI or not, should have user documentation.  {{addcategory|{{PAGENAME}}}}


Note that ''programmer'' documentation is a different thing.  That is documentation for people who will modify the source of a program or use a library in their own code.  Programmer documentation belongs in the [[:Category:Programmer Documentation|Programmer Documentation category]].
Note that ''programmer'' documentation is a different thing.  That is documentation for people who will modify the source of a program or use a library in their own code.  Programmer documentation belongs in the [[:Category:Programmer Documentation|Programmer Documentation category]].


[[Category:Software Documentation Pages]]
[[Category:Software Documentation Pages]]

Latest revision as of 17:04, 9 November 2008

This category is for pages that serve as 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.

The titles of user documentation pages should be in the form "<Program Name>/user documentation". Every significant piece of software, whether it has a GUI or not, should have user documentation. To add a page to this category, include the code [[Category:User Documentation]] at the bottom of that page's source code.

Note that programmer documentation is a different thing. That is documentation for people who will modify the source of a program or use a library in their own code. Programmer documentation belongs in the Programmer Documentation category.

Pages in category "User Documentation"

The following 4 pages are in this category, out of 4 total.