Guide framework/structure

[jfredrickson5]

Restructure the Guides section so that guides are divided into categories. Those categories can be based on role. Example: https://www.gov.uk/service-manual

[jfredrickson5]

I'm thinking that each guide can have "category" and "audience" metadata fields. Each guide can have multiple audience types. I also think that initially each guide should only fit into one category, though it'd certainly be possible to assign a guide to multiple categories.

This will allow us to primarily organize the guides into categories, while also allowing us to highlight useful guides for specific audiences.

Possible categories, along with example guide topics:

• Agile
  • Introduction to the idea of agile
  • How you know you're doing agile well
  • Enterprise adoption of agile principles
  • Starting an agile project
  • The principle of continuous delivery
  • Pilots and failing fast
• Design
  • User-centered design
  • Accessibility/508
  • User experience
  • UI design
  • Data visualization
  • Plain language
• Project Management
  • Forming a project team
  • How to do Scrum
  • How to do Kanban
  • Tracking agile project progress (metrics, burndown, etc)
  • Project phases
  • How to continuously deliver a product
• Governance
  • Open source policy
  • Open data policy
  • Policy implementation
  • IT organizational structure (e.g., DevOps vs traditional)
• Development
  • Coding practices
  • Source control practices
  • API guidelines
  • Testing practices
  • Release engineering
  • DevOps
• Team
  • Job descriptions
  • Work environment
  • Tools and resources needed by an agile team
  • Onboarding (GSA CTO specific)
  • User network access
  • Communication tools (chatter, gmail, gdrive, hangouts)
  • Project tracking (Jira)
  • GitHub account setup
  • Meetings & Meeting Tools
  • Two Factor Authentication
  • Equipment
  • Travel & Events
  • Professional Development & Training
  • Time & Attendance

Possible audiences:

• Developers
• Executives
• Project managers
• UI/graphic designers
• Operations
• Information security
• Non-technical stakeholders
• Content editors

[jcastle-zz]

The structure looks good. I would stay away from "governance" as it connotes something legacy. We can come up with a different name.

For now, we can have placeholder links for all of the categories and roles and then work to build them out.

[afeld]

The information architecture is far from perfect, but here is @18F's list:

https://pages.18f.gov/guides/