Proposal for Content of Documentation Pages.#

Some ideas for consistent documentation content.
See also Proposal for Naming of Documentation Pages.

For short technical features (Plugins, Tags, ...). Here is an incomplete example page (yellow background) for Wiki.Plugin.Index:

Wiki - Plugin

Index Plugin#

Displays all of the pages in this Wiki in alphabetical order.

Contributed by AlainRavet.

Parameters#

name defaultused for
itemsPerLine? break every 'n' items on line.
include *
. . . . . . . . .

Restrictions#

???

Known Bugs#

none

Example#

[{INSERT IndexPlugin include='Wiki.*'}]

produces output like this:

See also#

Used in Wiki.Info.Index.

Suggestions and Discussions#

Should go here: Wiki.Plugin.Index.Discussion

For pages like installation instructions.
Most pages won't fit exactly into this scheme but at least some concepts should useful.

Some Documentation#

Short description

Introduction#

Some Heading#

Example:

[{INSERT IndexPlugin include='Wiki.*'}]

produces output like this:

Some Heading#

Frequently asked Querstions#

Subject xxx#


Q: Why?

A: Therefore.


Q: Why?

A: Therefore.


Subject yyy#


Q: Why?

A: Therefore.


Q: Why?

A: Therefore.


Restrictions#

???

Known Bugs#

none

See also#

WikiBlaBla.

Suggestions and Discussions#

Should go here: Wiki.SomeDoc.Discussion

  • [Wiki] - [Plugin|Wiki.Plugin]: i have not tested NamespacePlugin but links to upper hierarchies seem to make sense.

    Even better: 'NamespaceTag' (to be written) that replaces <wiki:PageName /> in Header.jsp and writes

    Wiki.Plugin.Index

    (one link for Wiki, one link for Wiki.Plugin; plain text for Wiki.Plugin.Index as this is the actual page)
  • !!!Index Plugin: a big heading for each page seems to be better than relying on page names (at least for internationalized pages)
  • Parameters with their default values should be listed in a table (clear and compact; names for table headings are copied from http://www.jspwiki.org/wiki/WikiMap)
  • Example output should be displayed with some background color so that the reader sees it at one glance.
  • Suggestions and Discussions: should stand on a separate page ending with '.Discussion'. A documentation page should describe the actual function of the software and old bugs or further ideas should be placed elsewhere.

-- Frank_Fischer


  • You can't mean that all documentation pages should look like this, can you? This is appropriate for a reference (say, to a particular plugin), but I think there are many topics that need a more conversational style. DanF

  • This skeleton could be usable for documentaion of most plugins and tags, forms, aliases, URLProviders etc.
    Many of the current pages fall into this scheme.
  • For more conversational style some features should remain, some have to be added and some are not applicable. I have added an unfinished proposal above.

-- Frank_Fischer

Add new attachment

In order to upload a new attachment to this page, please use the following box to find the file, then click on “Upload”.
« This page (revision-140) was last changed on 26-Dec-2007 10:17 by Guest  
G’day (anonymous guest) My Prefs
This is the left menu footer
JSPWiki v2.8.3-svn-4