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

Improve table of publications design #268

Merged
merged 8 commits into from Oct 22, 2014
Merged

Improve table of publications design #268

merged 8 commits into from Oct 22, 2014

Conversation

@fofr
Copy link
Contributor

@fofr fofr commented Oct 17, 2014

The existing mainstream publisher tables are cluttered, and the columns aren't optimum for the tasks the tables are used for. User research has highlighted some columns that can be removed or simplified. The main task the table is used for is finding work to do — the key information in this task is document title and last updated date.

  • Make titles more prominent and clickable; easily find an item and go directly to its edit page
  • Remove the section column; this gets set in Panopticon at creation and is checked by 2i, this can be checked from the document metadata tab and doesn't need to be in the table
  • Move slug to beneath the title and use it to link to a preview of the edition. Slug can be useful, but it doesn't need its own column.
  • Remove the edit and preview columns and icons
  • Make the edition number less prominent
  • Use user friendly dates in columns, as recommended by the style guide. Remove the timestamps from the column but leave them there as a title attribute for the few occasions it is needed
  • For published documents, link to a locked view of the edit screen.
  • Remove the columns for viewing, editing and previewing published documents

There's some repetition in the old templates, this could be DRY'd up. I've opted to do that in a later PR.

Before

screen shot 2014-10-17 at 13 44 21
screen shot 2014-10-17 at 13 44 48

After

screen shot 2014-10-17 at 13 41 53
screen shot 2014-10-17 at 13 42 17

Date title attribute

screen shot 2014-10-17 at 13 43 02

fofr added 8 commits Oct 16, 2014
Research showed that the column wasn’t used when browsing publication
tables. It’s a wide column that clutters the view.
Section has been removed from the browse table, but should remain
available within Publisher.

It looks like the intention was to include section but it isn’t
currently working. Explicitly add it back in.
Create a larger hit point in the area users are focusing on when
browsing the table of publications.

* Link to the locked edit view when a publication is published
* Link the sibling draft message too
The slug is useful information when alongside the title, although that
information isn’t used to scan the table for a document to work on.

* Move the slug beneath the title so they can be directly compared
* Remove the wide slug column to improve table legibility
* Link the slug to the published version or the preview, depending on
state
Titles are the main differentiator of publications and are used the
most when scanning the table.

* Make the title larger and more legible
* Use #X notation for brevity.
* Match colour of slug link
* Use human readable date formats that match our style guide
* Shorten columns to show only the date, put provide the full date as a
title attribute if the user needs to check
The edit view can be consistently reached via the link on the
publication title. The preview can be reached via the link on the
publication slug.

* Remove the 2-4 columns for edit, preview, locked view
* Keep an actions column when a new edition can be created from a
published or archived edition. Shorten button text.
@dhwthompson
Copy link
Contributor

@dhwthompson dhwthompson commented Oct 17, 2014

barney-likes-you

@JordanHatch
Copy link
Contributor

@JordanHatch JordanHatch commented Oct 17, 2014

+1 for the West Wing references

@marksheldonGDS
Copy link
Contributor

@marksheldonGDS marksheldonGDS commented Oct 17, 2014

👍 x 💯

@vinayvinay
Copy link
Contributor

@vinayvinay vinayvinay commented Oct 20, 2014

@fofr: good clean-up! you might want to double-check about dropping the section column, because recently someone had raised an issue about the section value missing from this column, which makes me think it is gets used.

@vinayvinay vinayvinay self-assigned this Oct 20, 2014
@fofr
Copy link
Contributor Author

@fofr fofr commented Oct 22, 2014

@vinayvinay I checked with Jon Sangar and Liz H. If it is a problem I think it's easy enough to put back.

vinayvinay added a commit that referenced this pull request Oct 22, 2014
Improve table of publications design
@vinayvinay vinayvinay merged commit 11639bd into master Oct 22, 2014
1 check passed
1 check passed
default "Build #341 succeeded on Jenkins"
Details
@vinayvinay vinayvinay deleted the better-docs-tables branch Oct 22, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.