Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complex description of feature in user guide: section on deleting a tag #10

Open
w-yeehong opened this issue Nov 13, 2020 · 1 comment

Comments

@w-yeehong
Copy link
Owner

Expected Outcome

The section on Deleting a tag can show a step-by-step example to illustrate what happens when a tag is deleted.

Description

The section uses terms such as parent-tag that may be difficult for the target user to understand.

image.png

@nus-se-bot
Copy link

Team's Response

I am genuinely confused as to what the bug is here. The "expected outcome" seems more like a suggestion. There are no extra steps to show to the user to illustrate program behaviour.

The illustration denotes parent-tags with 'p' and child-tags with 'c' and shows clearly the remapping of arrows after the tag is deleted. The most that could have been done is to illustrate each parent tag as such

bug response image.png

which does not seem like a direct improvement. For this version, we have to explicitly state that the child nodes 'c1' and 'c2' in both refer to the same nodes. This is automatically implied in the diagram we have used.

We acknowledge that this behaviour is rather complex and the image itself was meant to address this.


As a separate issue, you also highlighted that parent-tag may be difficult to understand but child-tag was not highlighted. It seems quite evident that child-tag is the opposite of parent-tag. The definition for parent-tag is also given in the glossary.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: [replace this with your reason]


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants