You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ctakes.apache.org by Andrew McMurry <an...@invitae.com> on 2013/12/04 20:33:23 UTC
Proposal: Using JIRA to track and request changes to documentation
Hi all
I'll have an update about the VM situation shortly (positive news) but in the meantime I propose a new issue type in JIRA: doc.
The ctakes docs are very good, and James deserves a lot of credit.
User docs are as important as code, sometimes even more so.
It is therefore appropriate to track how documentation is being updated with release versions.
Example of DOC issues worth tracking in JIRA:
* "Confluence home page still refers to version 3.0 by default"
* "User FAQ should state recommended JVM memory size"
* "User FAQ should point to UMLS setup instructions"
As an added benefit, each time we do a release we can see if the docs need to be updated accordingly.
I am *NOT* proposing that every change to documentation requires a JIRA ticket.
But we should have a mechanism to record doc issues.
Do you agree with the proposal?
--AndyMC
RE: Proposal: Using JIRA to track and request changes to
documentation
Posted by "Finan, Sean" <Se...@childrens.harvard.edu>.
+1 to [version update], [new section] and [large change required] Jiras for documentation.
+1 to James deserving credit.
-----Original Message-----
From: Andrew McMurry [mailto:andrew.mcmurry@invitae.com]
Sent: Wednesday, December 04, 2013 2:34 PM
To: dev@ctakes.apache.org
Subject: Proposal: Using JIRA to track and request changes to documentation
Hi all
I'll have an update about the VM situation shortly (positive news) but in the meantime I propose a new issue type in JIRA: doc.
The ctakes docs are very good, and James deserves a lot of credit.
User docs are as important as code, sometimes even more so.
It is therefore appropriate to track how documentation is being updated with release versions.
Example of DOC issues worth tracking in JIRA:
* "Confluence home page still refers to version 3.0 by default"
* "User FAQ should state recommended JVM memory size"
* "User FAQ should point to UMLS setup instructions"
As an added benefit, each time we do a release we can see if the docs need to be updated accordingly.
I am *NOT* proposing that every change to documentation requires a JIRA ticket.
But we should have a mechanism to record doc issues.
Do you agree with the proposal?
--AndyMC