Collect user stories

Problem/Motivation

Let's collect user stories for this module to help anyone who want to work on this module.

Proposed resolution

User stories

• As a developer I want to know which element's cache is affected by ... (e.g. user permission).
• As a developer I want to know what affects the cache of this ... (e.g. block)
• As a developer I want to know the lifetime of this ...'s (e.g. block) cache
• As a developer I want to know which element makes the cache lifetime of the ... (e.g. page) to be ... (e.g. 1 minute)
• As a developer I want to know which cache ... [keys|contexts] are added by this ... (e.g. block)
• As a developer I want to know whether page cache is enabled or not (including max-age = 0)
• As a developer I want to know which elements have 'max-age = 0'
• As a developer I want to module to analyze the cache properties automatically and warn me of any abnormal situations.
• As a developer I want to module to help me to fix a common cache problem (tell what to do).
• As a tester I want to verify that ... [a piece of sensitive data] will never be exposed to ... (e.g. un authorized users)
• As a tester I want to check the cache tags of the ... (a piece of sensitive data) and all of its parents and verify that tags ... (e.g. user.permissions) are provided and that they bubble up.
• As a developer I can select a DOM element.
• As a developer I can see the tags, context and cache lifetime of a selected DOM element.
• As a developer I can distinguish tags, contexts and lifetime that were added to a DOM element from tags, elements or lifetime inherited from the element's children.
• As a developer I can navigate to parent of a selected DOM element.
• As a developer I can search a tag, context or cache lifetime and all elements that add this will be highlighted.
• As a developer I can search a tag, context or cache lifetime and all elements that add or inherit this will be highlighted.
• As a developer I want to browse through the result set elements (e.g. previous/next). So I can check each and won't mis any of them.
• When I click previous or next, I want the page to scroll to the point where the element is placed. That saves me scrolling through a long page.
• As a developer I want to each result to be highlighted while browsing through the result set. So I have visual feedback and can easily recognize the element.
• As a developer I want to have information from the html (e.g. html-element, classes, id, typeof, role) of the element while stepping through the result set. So I can recognize the element based on these properties. Sometimes (for example when elements are small, packed together, are a wrapper or otherwise empty) visual feedback alone is not enough.
• As a developer I want to see all cache contexts, all tags and the max-time of an element.
• The interface with which I can browse through the result set should be fixed and not move when I scroll the page. That way I can always and easily reach the previous/next button when the page has scrolled.
• When I point to a result (e.g. hover over or click) the details of this element should be displayed. So I can choose to inspect an element without the need to browse (step) untill I reach it.
• As a developer I want to search for contexts/tags/max-time by selecting (double clicking) a contexts/tags/max-time in the inspector.
• As a tester I want to have more information about the meaning of some contexts and tags. For example I do not understand the meaning of tag 'block_view'
• As a developer I want to see which elements have (replaced) placeholders. So I understand that their content may change without the cache being refreshed.

Remaining tasks

• Complete the list of user stories
• Prioritize the stories