Details
-
Improvement
-
Status: Open
-
Major
-
Resolution: Unresolved
-
None
-
None
-
None
-
None
Description
Our current strategy of using javadocs for "developer" documentation and the wiki for documenting "user" features only gets us so far – among other things, it makes it hard to include the "user" documentation in our releases, but it also results in a disconnect between when code changes and when documentation gets updated.
in an ideal world, "user" documentation would live in the code right along side the implementation, just like with javadocs – but the standard set of information displayed by javadocs isn't very user friendly. we should find a better way to allow us to "edit" the info about how to use a plugin right along side the code for that plugin and generate user friendly documentation from that.