18F / archived-guides

A collection of 18F guides.
https://guides.18f.gov
Other
20 stars 12 forks source link

Guides naming conventions #32

Open coreycaitlin opened 8 years ago

coreycaitlin commented 8 years ago

This is related to #31, but slightly separate. Here's the current list of names in the nav on the guides page. I've included the title shown while in the guide, if different, in parentheses.

Some questions this raises:

wslack commented 8 years ago

I like the idea of having "18F" in the main title of the guide homepage, but not in the guides nav, for people linking directly. Otherwise, it looks like we're doing a decent job with the nav titles only saying "18F" when the subject matter is about 18F.

mbland commented 8 years ago

I like the idea of the presence of "18F" in the title being a signal that the advice is very 18F-specific. With this and the naming standardization, as I suggested in #31, perhaps we can get a design studio going with UX and Content folks to forge the One Ring once and for all.

coreycaitlin commented 8 years ago

I like both these ideas — and agree with @wslack that we need solid indicators (whether or not it's in the title) of where these guides came from.

I wonder if deciding how 18F-specific each guide is will be simple or surprisingly complicated. Again, I think a design studio would tell us a lot.

coreycaitlin commented 8 years ago

Based on a brief card sort exercise with @mbland, @wslack, and @brethauer, we seemed to agree that the following things listed in the guides nav are not, in fact, guides:

This suggests that we need a definition for what is a guide! Here's a straw sentence or two:

18F Guides are documents about how we work (our process, standards, and patterns). 18F teams write guides to help colleagues, partners, and peers learn from our experience and work together more smoothly.

I'm not sure this excludes all the things that didn't feel as guide-like, but it helps sort out a few of them.