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

Create content and copy guidelines for the UX guide #585

Open
2 of 6 tasks
Tracked by #580
claireb-gsa opened this issue Jun 7, 2024 · 5 comments
Open
2 of 6 tasks
Tracked by #580

Create content and copy guidelines for the UX guide #585

claireb-gsa opened this issue Jun 7, 2024 · 5 comments
Assignees
Labels
blocked Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" UX Task related to the UX Guide and/or pulled from the old UX Guide repo.

Comments

@claireb-gsa
Copy link
Contributor

claireb-gsa commented Jun 7, 2024

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 (#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 #580

Related work (Maybe?)

Update documentation of guide codeowner role #790

Tasks

  1. claireb-gsa
@claireb-gsa claireb-gsa added Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" Guides UX Task related to the UX Guide and/or pulled from the old UX Guide repo. labels Jun 7, 2024
@bpdesigns
Copy link
Member

@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
Copy link
Contributor Author

@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
Copy link
Member

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

@bpdesigns
Copy link
Member

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

@claireb-gsa
Copy link
Contributor Author

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

@bpdesigns bpdesigns changed the title PROPOSED: Create content and copy guidelines for the UX guide Create content and copy guidelines for the UX guide Jun 17, 2024
@claireb-gsa claireb-gsa self-assigned this Jun 17, 2024
@allisonpress allisonpress self-assigned this Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" UX Task related to the UX Guide and/or pulled from the old UX Guide repo.
Projects
None yet
Development

No branches or pull requests

4 participants