Feature #2568

Issue status documentation

Added by Thomas Woelfle about 10 years ago. Updated over 4 years ago.

Status:NewStart date:2009-01-23
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:Issues
Target version:-
Resolution:

Description

We have the problem that users are not always sure what the semantic of a certain status is and what status they should set for a ticket when updating it.

Therefore it would be nice to be able to add a documentation to issue statuses, especially when introducing custom statuses. The documentation could then be presented to the user as a tooltip when selecting a status for a ticket.


Related issues

Related to Redmine - Feature #705: Wiki links on field names New 2008-02-21
Related to Redmine - Feature #442: Add a description for trackers Closed
Related to Redmine - Feature #366: Custom field for issue status New
Related to Redmine - Feature #4768: "issue category" should have a "description" field New 2010-02-08
Related to Redmine - Feature #5026: Description field for Status/Role/Tracker setting. New 2010-03-10
Duplicated by Redmine - Feature #12002: I'd like to see an Issue Status Description Closed

History

#1 Updated by Jerome Vanthournout about 10 years ago

+1
I would also really appreciate this feature.

#2 Updated by Thomas Woelfle about 10 years ago

The same would be nice for categories and priorities too.

#3 Updated by Thomas Pihl about 10 years ago

Why not just document them on the wiki?

I have a page for each of those (incl some custom fields as well)

/T

#4 Updated by Thomas Woelfle about 10 years ago

Thomas Pihl wrote:

Why not just document them on the wiki?

I have a page for each of those (incl some custom fields as well)

/T

That's what we are doing currently. Some of our developers mentioned that it would increase the usibility if they do not have to open one or more wiki pages (for statuses, categories, priorities, ...) while creating or updating issues.

Well, as said, it is just a usibility feature request.

#5 Updated by Brad Mace almost 10 years ago

If you could attach a description to each status/category/priority then it could be displayed as a tooltip, vs having to look it up on the wiki.

#6 Updated by Dipan Mehta about 6 years ago

+1 This is very important. Usually, when reading in a wiki you read things like reading a book - you don't know what to search for where. When people are in the 'act of doing things' it makes sense to give them tool tip or some contextual help which doesn't requires them to move around pages. This is very very crucial!

The closest to this I had came across - is extended fields which provides Hint per field. Again, this doesn't help about core fields, and also it is not sufficiently contextual i.e. different for each tracker/status to tell users "what they should write HERE and NOW!"

#7 Updated by Daniel Felix about 6 years ago

This could be solved too by a new look of the issue generation.
Maybe I could provide a new issue assistent the coming weeks.

#8 Updated by Toshi MARUYAMA about 6 years ago

  • Category set to Documentation

#9 Updated by Dipan Mehta about 6 years ago

Why is the category documentation? The feature is actually asking for 'Tooltip/Hint/Help framework based on context' in Redmine.

#10 Updated by Dipan Mehta about 6 years ago

Issue #442 talks about contextual documentation of Tracker rather than Status or custom fields However, we can have generic frameworks that can encompass all such contextual help/documentation aspects.

#11 Updated by Toshi MARUYAMA about 6 years ago

  • Category deleted (Documentation)

#12 Updated by Dipan Mehta about 6 years ago

Add related #9256 - the framework of #2568 essentially will cover that.

#13 Updated by Dipan Mehta about 6 years ago

Another related #4768 - essentially documenting and contextually describing 'Category' (e.g. what type of issues qualify for this category) is another important example.

#14 Updated by Dipan Mehta about 6 years ago

Another related #5026 - requires description/documentation for Status/Role/Tracker.

Looks like, there is a lot of demand for the 'instant end-user documentation'

I was wondering, while issue #9256 is already planned under Candidate for next major release, will it be a good idea to have #2568 in the same release?

#15 Updated by Mischa The Evil over 5 years ago

  • Related to deleted (Feature #9256: Trackers have a description in addition to a name)

#16 Updated by Toshi MARUYAMA over 4 years ago

  • Category set to Issues

#17 Updated by Toshi MARUYAMA over 4 years ago

  • Duplicated by Feature #12002: I'd like to see an Issue Status Description added

Also available in: Atom PDF