Create content and copy guidelines for the UX guide

claireb-gsa commented 5 months ago

The work

The UX guide needs content guidelines as well as specific editorial copy guidelines to ensure consistency.

Assumption: Content for these guidelines will be identified during the process of rewriting Research content (https://github.com/18F/guides/issues/584)

Potential questions

What is guide content v a resource v a method card?
What should/can we link to?
General structure of content (intro, story, resource)
Also style considerations that are guide-specific from the copy and consistency approach

Draft document: UX Guide and Methods - Content strategy and editorial guidance - draft and questions

Goals

set guidance for the rewrite of key content in this project
give guidance to new contributions

Epic

EPIC: Updates to the architecture and content of the UX Guide https://github.com/18F/guides/issues/580

Related work (Maybe?)

Update documentation of guide codeowner role #790

### Tasks
- [x] extract useful content on the archived methods git site https://github.com/18F/methods (readme and wiki)
- [x] extract useful content on the archived ux guide git site https://github.com/18F/ux-guide (readme and wiki)
- [ ] Synthesize into new drafts
- [ ] Identify content gaps
- [ ] identify style gaps
- [ ] https://github.com/18F/guides/issues/647

bpdesigns commented 5 months ago

@claireb-gsa have you seen the wiki's for the archived Methods and UX Guide sites? These have answers to some of the questions you are asking. Perhaps its a matter of where they live?

claireb-gsa commented 5 months ago

@bpdesigns yeah, I have - some of the content is there, so deciding on a new home for all of this would help. Is it the guides wiki? Is there already a ticket/work planned to migrate the archived site content?

There are also a lot of questions that the current content I've found doesn't answer, so work to be done around that.

bpdesigns commented 5 months ago

Don't see a wiki for the overall guides but there is the readme and codeowners file

bpdesigns commented 5 months ago

@claireb-gsa can you link a doc with your questions here?

claireb-gsa commented 5 months ago

Sure - I pulled them out of the readme and added more: UX Guide and Methods - Content strategy and editorial guidance - draft and questions

18F / guides