Discuss help and local documentation for users
The notations guide is about the only online help available for information about markup and macros. With the advent of WYSIWYG editing, the basic stuff becomes less important. However, with every increasing set of sophisticated macros, the need for a much better and easier to use documentation format is very important. Instead of having a unique notations guide with limited formating, why not use Confluence pages and capabilities? There are some very good examples documentation pages starting to appear. For instance Adaptavist and some of the information on David Peterson's plugins. I have been thinking of documenting some of this stuff for our own site, so the need is there. Now I would prefer something that is installed locally on my site that represents exactly the macros that have been enabled on our site (similar to the notation guide capability). Having the documentation behave like normal Confluence stuff would make it much easier for users.
Comments (1)
Dec 27, 2005
Charles Miller says:
One thing we should do, once we have the user guide updates occurring in time fo...One thing we should do, once we have the user guide updates occurring in time for the final releases, is to ship the user guide space with Confluence, (and, as they are completed, the admin and developer guides) so that customers can have the online user guide as part of their own installations.
Another thing we could do is give macros some way to document themselves in wiki-markup, and then provide macros for including that documentation in a page – so you could build your own macro guide as part of your own documentation...