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

QA press release and weekly digest content #488

Closed
1 task done
Tracked by #60 ...
noahmanger opened this issue Sep 13, 2016 · 9 comments
Closed
1 task done
Tracked by #60 ...

QA press release and weekly digest content #488

noahmanger opened this issue Sep 13, 2016 · 9 comments
Assignees

Comments

@noahmanger
Copy link

noahmanger commented Sep 13, 2016

In order for all imported content to look as good as possible, do a QA process of all imported press release and weekly digest content and publish.

Tasks:

  • Figure out how far back we care about
@emileighoutlaw
Copy link
Contributor

If this becomes an all hands on deck situation (depending on how much we need to review and the turnaround time), I can shift content focus and devote most of my time to review.

@noahmanger
Copy link
Author

Ok, as I'm beginning to do this work, I'm finding some style things we should decide.

  1. Should the headings be h2 and sentence case?
    Old:
    image

Suggested:
image

  1. When do we use bulleted lists?
    There's several places where sections contain multiple items. The default style is for them to each be a paragraph, but maybe we should be using bulleted lists?

https://beta.fec.gov/updates/week-of-september-5-september-9-2016/
image

  1. Do we bold terms at the beginning of items like this?
    image

Here's an example of a page that I cleaned up: https://beta.fec.gov/updates/week-of-september-5-september-9-2016/

And here's the default imported style: https://beta.fec.gov/updates/week-of-august-29-september-2-2016/

cc @jenniferthibault @emileighoutlaw

@emileighoutlaw
Copy link
Contributor

Definitely I agree that headings should be sentence case.

Bolding terms can be useful to users when it underscores important words and phrases. In this case, it doesn't feel very useful to have very similar dates as the only thing in bold. Mostly, the bold feels like a way of highlighting where one event ends and another begins. In which case I do think a list would do that equally well.

Upcoming educational programs

  • September 22: Roundtable Workshop/Webinar on Reporting PACs and party committees. More information is available linkedy link.
  • September 22: Roundtable Workshop/Webinar on FECFile for PACs and party committees. More information is available linkedy link.
  • September 28: Roundtable Workshop/Webinar on Reporting for for candidate committees. More information is available linkedy link.
  • September 28: Roundtable Workshop/Webinar on FECFile for for candidate committees. More information is available linkedy link.

versus

Upcoming educational programs

September 22: Roundtable Workshop/Webinar on Reporting PACs and party committees. More information is available linkedy link.

September 22: Roundtable Workshop/Webinar on FECFile for PACs and party committees. More information is available linkedy link.

September 28: Roundtable Workshop/Webinar on Reporting for for candidate committees. More information is available linkedy link.

September 28: Roundtable Workshop/Webinar on FECFile for for candidate committees. More information is available linkedy link.

As to whether a list or bold is the right visual styling, I'll defer to @jenniferthibault and say that my preference is for list.

@noahmanger
Copy link
Author

That makes sense to me. I think I prefer bullets in those instances. What about with stuff like this, though (page)

image

A lot of content in the digests is essentially lists. Should they all be bulleted?

@jenniferthibault
Copy link
Contributor

I'm totally ok with bullets being the default format for lists.

I'm seeing a distinction though that may be helpful.

Advisory opinions and Audits seem to have a document title with a full explanatory paragraph beneath. In these cases, I think setting each off with the title as an h4 gives them some distinction, and helps keep it from feeling tooooooooo over-listed.

screen shot 2016-10-06 at 11 27 21 pm

screen shot 2016-10-06 at 11 33 28 pm

screen shot 2016-10-06 at 11 39 03 pm

That means the list/paragraph choice is determined by category:

Commission meetings:

  • bullet list

Advisory opinions:
paragraph

Enforcement:
intro paragraph

  • bullet list

Alternative dispute resolution
intro paragraph

  • bullet list

Audits:
paragraph

Litigation:

  • bullet list

Outreach:

  • bullet list

Educational programs:

  • bullet list

Press releases:

  • bullet list

Campaign finance reports:

  • bullet list

Upcoming commission meetings and hearings:

  • bullet list

Upcoming educational programs:

  • bullet list

Upcoming reporting due dates:

  • bullet list

Disclosure initiatives:

  • bullet list

Additional research materials:
paragraph


While I did this, I noticed something weird. There seem to be duplicate/redundant categories:

  • Educational programs and Upcoming educational programs
  • Commission meetings and Upcoming commission meetings and hearings

Is this something we want to get into now?

@noahmanger
Copy link
Author

I never responded, but I really like these suggestions. My only issue is that sometimes the category content varies from week to week. Sometimes a category that you identified as a bullet style either only has one item or it has several rather lengthy items. Do we want to bullets in this case?

I finished all of the 2016 press releases and have done several weekly digests. The digests are definitely more time consuming. They take about 5 minutes each (compared to just 2 for the press releases), and there's about 45 left, which means 3.5-4 hours of work to get through 2016. Before we invest all that time, I'd like to run our suggested formatting by the press office to make sure they agree with our choice of bullets, headings, etc., and with our partners to make sure they want us to spend that time cleaning up prior digests.

@jenniferthibault
Copy link
Contributor

I finished making the 2016 Weekly Digests consistent. For a next step, I created an issue to make a formatting guide for these documents so that it's easy to keep them consistent (and in some cases improve existing formatting decisions) in the future. 18F/fec-style#544

@jenniferthibault
Copy link
Contributor

All 2016 press releases done too!

@noahmanger
Copy link
Author

Thank you! Closing.

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

No branches or pull requests

3 participants