andywer / postcss-debug

Debug your postcss workflow with ease! Creates snapshots of your CSS files before/after each postcss plugin is run.
MIT License
95 stars 7 forks source link

Better UX #1

Closed ai closed 8 years ago

ai commented 8 years ago

Tools is awesome, but look and feel is just prototype. We should do it better:

  1. Should we use PostCSS’s red color?
  2. Initial @ 0ms, we don’t need time here.
  3. We need some arrow to show that plugin links could be expanded. Of course, this arrows should have 2 states for normal and expanded view.
  4. Maybe we should draw files as tabs? It will should hierarchy of content (that every file has own expanded links).
  5. You should put time to right with different color. It will be much readable.
  6. Also we could use different color for time to highlight slowest one.
andywer commented 8 years ago

Help from the community would be cool for this ticket, since redesigning the color palette for example can be done without much technical background.

andywer commented 8 years ago

Check out https://github.com/andywer/postcss-debug/tree/develop :) I addressed a good bunch of the mentioned suggestions.

ai commented 8 years ago

Nice work! Second step:

  1. Change a header background. Red logo and blue background has bad contrast. Also, because this header is not useful for user, you could use white background.
  2. Highlight file name in file paths in tabs. Paths are long and we should help user with reading.
  3. We should group plugin button with its code example. Maybe with some space between plugins.
  4. Maybe we should show only diffs with "full content" button.
  5. We can remove "took" from time labels.
  6. We could change footer background to white, because it is not useful for user too.
andywer commented 8 years ago

Thank you for the quick feedback! Some styling improvements can be done quickly, but I doubt that I will find the time to address all of this in the near future.

So to all visitors of the issues section: If you like what you see feel free to participate!

ai commented 8 years ago

Third step:

  1. Make “Debugger” font smaller. It is not main content of the page.
  2. Remove borders between header, footer and files section — because this borders is useful for user. He/she already see a separation between sections by space.
  3. You could remove “Files” section too, because user will see that it is a files section by file names in tabs.
  4. Border-radius in code example is out of style (all other elements has no border-radius)
  5. We should show only real difference between files in tabs and hide common folders. For example, if we have /home/ai/dev/project/css/logo/logo.css and /home/ai/dev/project/css/header/header.css, we should show logo/logo.css and header/header.css (maybe in this case we could remove file name highlight)
ai commented 8 years ago

Also our design become better and better and now we have more complicated questions:

How many files user will have? If it will have more than 10 files, it will be hard to display them in tabs. We should go to left-side menu.

andywer commented 8 years ago

Yeah, good points indeed. But since it is still a beta version, I just released the current state of progress as version 0.2.0.

One additional question: 4. border-radius: There is no border-radius on any component...

Cheers

ai commented 8 years ago

@andywer yeap, improving is end-less process :). So we could make release on every step.

Hm, strange, I see a border-radius on screenshot. Maybe it goes from CSS highlight library? Or it is just screenshot artifact? (If you don't see it, we can forget about this point)

andywer commented 8 years ago

Ahh yeah, right. The <pre>'s border-radius comes from bootstrap. Should probably throw the damn dinosaur out of here...

ai commented 8 years ago

+1 to remove Bootstrap. Its CSS is so bad :).

pgrekovich commented 8 years ago

Hi! What do you think about the position of the panel? I think it is better, especially for long files. We can make a horizontal accordion. p.s. Sorry for my eng (:

postcss-debugger

andywer commented 8 years ago

Hey @pgrekovich! Thanks for sharing your idea. I can clearly see you motivation, but I fear it's only going to work if you only use very few PostCSS plugins.

The application of my current client uses CSS modules and some other PostCSS plugins for convenience features and that sums up to about 9 plugins in total. That would mean 10 snapshots side by side...

andywer commented 8 years ago

Btw: Just a quick note. Removing bootstrap has already been done in #5 by @Gaserd :)

pgrekovich commented 8 years ago

@andywer yeah, you'r right. I still think about it. How else can I help you?

andywer commented 8 years ago

@pgrekovich Documentation is an issue right now (#4). Maybe you have some ideas how to improve it?

Gaserd commented 8 years ago

@andywer See it. 2016-06-01 12 43 36

ai commented 8 years ago

@Gaserd I think we should remove plugins from aside. Two plugins panels confuse users.

andywer commented 8 years ago

@Gaserd @ai Agree. The search functionality for the plugins seems a bit too much, too.

But I really like searchable files selector, though :)

Gaserd commented 8 years ago

@ai @andywer ok. Maybe this ?

(?) - link documentation on plugin

2016-06-01 13 22 23

ai commented 8 years ago

I like it (links to plugin page is really useful)

andywer commented 8 years ago

Pretty cool! 👍

ai commented 8 years ago

Maybe we should make files bigger? Bigger button — less time to click (by Fitts's law)

andywer commented 8 years ago

Not sure, maybe. We should make the files sidebar and the content area stretch to the whole screen width minus some padding, though. But this is only a detail.

Gaserd commented 8 years ago

Increased "file button" and added flex area on "file list" 2016-06-01 14 26 47

I think about hiding area on "file list", then open full window width "plugin files" area. What your think, need that function ?

ai commented 8 years ago

I think we have space to not hide file panel. Simple is better

Gaserd commented 8 years ago

@ai Ok 👍

Gaserd commented 8 years ago

@andywer how we generate link in documentation for plugin ?

andywer commented 8 years ago

@Gaserd I suggest we use this: https://raw.githubusercontent.com/himynameisdave/postcss-plugins/master/plugins.json :)

ai commented 8 years ago

We could provide links to npm — so we will need only plugin name

ai commented 8 years ago

And you can take plugin name from plugin.postcssPlugin

andywer commented 8 years ago

@ai Sure, that's even simpler!

Gaserd commented 8 years ago

@ai @andywer I think about mobile version this page. What your think ?

ai commented 8 years ago

Why not? 😊

It week be useful even in desktop to put debug page in small sidebar near a webpage.

ai commented 8 years ago

But also we can do better graphic design (we fixed only UX). Better fonts, more modern graphic language (material design?).

Gaserd commented 8 years ago

@ai Yeah. I think about this. 👍

andywer commented 8 years ago

Suggestion: I will close this issue for now and we can open a new one for the remaining design part.