Opened 10 years ago

Closed 10 years ago

#3495 closed Task (fixed)

New keyword

Reported by: Artur Formella Owned by:
Priority: Normal Milestone:
Component: General Version:
Keywords: Cc:

Description

We need a good documentation, it would be useful to have a special keyword to mark important tickets. If ticket has this keyword (i.e Doc) it means that conclusion should be described in the documentation. When it is done - add Doc+. It would be independent from the normal ticket life cycle.

For example: Conclusion ( and the reason ) of #3480 should be described in the documentation.

Change History (4)

comment:1 Changed 10 years ago by Garry Yao

Wow! Really nice move.

comment:2 Changed 10 years ago by Garry Yao

I suggest to use 'toBeDoc' instead of 'Doc+', since 'Doc+' will have mis-sunderstanding with 'Review+', and 'whats Doc-' float into ones mind.

comment:3 Changed 10 years ago by Frederico Caldeira Knabben

I like it a lot also Artur. I think the following keywords can be used:

  • Doc?: Documentation should come out of the ticket.
  • Doc+: Documentation has been created, related to the ticket. A comment should possibly point to the added documentation.
  • Doc-: We should not really have documentation for it. Explanation should come with this keyword.

One could change from "Doc+" back to "Doc?" if the documentation is not complete or wrong, with explanations of course.

Should we go for it?

comment:4 in reply to:  3 Changed 10 years ago by Artur Formella

Keywords: Discussion removed
Resolution: fixed
Status: newclosed

Ok. Let's start to use this set of keywords:

  • Doc?: Documentation should come out of the ticket.
  • Doc+: Documentation has been created, related to the ticket. A comment should possibly point to the added documentation.
  • Doc-: We should not really have documentation for it. Explanation should come with this keyword.

Feel free to reopen this ticket if you have any suggestions.

Note: See TracTickets for help on using tickets.
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy