Harmonize Methods and UX Guide wikis
MelissaBraxton opened this issue · comments
Background
The UX Guide and the Methods both have GH wikis that are being used in different ways, and neither is supporting the current team as well as it could. We want to revise both wikis to centralize content that applies to both repos, and reduces the need to keep the info in sync.
READMEs are where we want to put info for the public audience.
Wikis are where we want to put info relevant to internal audience and teams maintaining these products. There may be content specific to each repo that we'll want to keep separate, but, in general we've decided to make the UX Guide the parent wiki for content that applies to both. The Methods wiki will point to content on the UX Guide wiki as needed.
Acceptance criteria (we'll know we're done when…)
- The wikis don't duplicate content
- Wiki content that applies to both repos is accessible from each
- An 18F staff member unfamiliar with the project can find what they need on the wiki and understand how to start working
Tasks
- Review wiki content
- Remove outdated or irrelevant content, integrate content suited to a public audience to the README.
- Draft new wiki in google doc content [Design/engineering]
- Set up syncing [Engineering]
- PO review
-
18F staff peer review
Based on our convo in today's co-working, we think we can sync individual wiki pages.
I've updated the task list and acceptance criteria to reflect our discussion and next steps!
The UX Guide wiki is looking great! Thanks @MelissaBraxton and @mgwalker! I added the draft content vision for the ux guide.
Sounds good to me!