Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
Plugin Documentation Standards?
#4
yojoe Wrote:How about addint a html readme (along with installation guide, usage examples etc.) inside plugin archives ?

I'd rather have only a small text file in the plugin (what it does and how to install it), as it's easier to create and easier to read without unpacking the zip.

Thus I'd rather see the most important information in the support topic. There it's easy to update when a new problem/solution is found. As for examples (for frontend functionality), I suppose there is nothing better than to show it on a website.
I18N, I18N Search, I18N Gallery, I18N Special Pages - essential plugins for multi-language sites.
Reply


Messages In This Thread
Plugin Documentation Standards? - by mvlcek - 2011-06-10, 20:01:53
Plugin Documentation Standards? - by yojoe - 2011-06-10, 23:53:51
Plugin Documentation Standards? - by mvlcek - 2011-06-11, 00:48:12
Plugin Documentation Standards? - by Oleg06 - 2011-06-11, 00:56:30
Plugin Documentation Standards? - by Connie - 2011-06-11, 00:58:10
Plugin Documentation Standards? - by RobA - 2011-06-11, 08:03:46
Plugin Documentation Standards? - by Connie - 2011-06-11, 16:16:59
Plugin Documentation Standards? - by ccagle8 - 2011-06-12, 00:48:57
Plugin Documentation Standards? - by ccagle8 - 2011-06-12, 23:57:06
Plugin Documentation Standards? - by mvlcek - 2011-06-13, 02:23:49
Plugin Documentation Standards? - by ccagle8 - 2011-06-13, 02:55:57



Users browsing this thread: 1 Guest(s)