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

Adding in Design Team Charter #103

Closed
wants to merge 10 commits into from
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,28 @@ The first `h1` or `#` will automatically become the page title. You can overrid

#### Links

Use relative links to other pages. Don't use github based links. In general internal links should not start with `http`. Instead they should either start with a directory or a file name. External links should start with `https://`. Links to other guides should end in `.md`, not `.html`.
Use relative links to other pages. Don't use github.com based links. In general internal links should not start with `http`. Instead they should either start with a directory, a file name or `../`. Links to other guides should end in `.md`, not `.html`. External links should start with `https://` and not point to restricted pages requiring an LZ account to view.

These rules ensure the links work from the both the github markdown side, and are properly converted to HTML links for the guides website.
These rules ensure the links work on github.com, and are properly converted to HTML links for the deployed guides website.

*Don't:*

```md
- [How to Write User Stories](https://github.com/labzero/guides/blob/master/product_design/how_we_write_user_stories.md)
- [How to conduct a presentation](process/presentation.html)
- [File in the same directory](/languages/sibling-document.md)
- [Our Website](labzero.com)
1. [.html file suffix](process/making-decisions.html)
2. [File in the same directory](languages/sibling-document.md)
3. [Page in a different directory using `/`](/other-dir/presentation.md) (only works on root level pages)
4. [Bare URL](labzero.com)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. [Bare URL](labzero.com)
4. [Bare URL](labzero.com) or [http URL](http://labzero.com)

5. [Link to a file in the github.com repo](https://github.com/labzero/guides/blob/master/product_design/how_we_write_user_stories.md)
```

Do:
```md'
- [How to Write User Stories](/product_design/how_we_write_user_stories.md)
- [How to conduct a presentation](/process/presentation.md)
- [File in the same directory](sibling-document.md)
- [Our Website](https://labzero.com)

```md
1. [.md file extension](process/making-decisions.md)
2. [File in the same directory](sibling-document.md)
3. [Relative link not starting with `/`](../other-dir/presentation.md)
4. [HTTPS URL](https://labzero.com)
5. [Relative link from within another directory](../product_design/how_we_write_user_stories.md)
```


Expand All @@ -55,7 +59,7 @@ For intra-page links to headings (e.g. `my-page#some-heading`). Use the heading
Example:

```md
If this page is `meetings.md`, one can link to the section below like:
If this file is `meetings.md`, one can link to the section below like:
[online meetings](meetings.md#conducting-an-online-meeting)


Expand All @@ -75,7 +79,7 @@ https://github.com/labzero/guides/blob/master/assets/images/lz-logo.svg

Do:
```
assets/images/lz-logo.svg
../assets/images/lz-logo.svg
```

#### file naming
Expand Down
48 changes: 24 additions & 24 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,42 +11,42 @@ Feel free to explore, and if anything catches your attention or raises questions

## Project Kickoff

- [Project Charter](/project_kickoff/project_charter.md)
- [Sprint Ceremonies](/project_kickoff/ceremonies.md)
- [Definition of Ready](/project_kickoff/definition-of-ready.md)
- [Definition of Done](/project_kickoff/dod.md)
- [Team Norms](/project_kickoff/team_norms.md)
- [Meeting Etiquette](/project_kickoff/meeting-etiquette.md)
- [Securing Your Workspace](/project_kickoff/securing_your_workspace.md)
- [Project Charter](project_kickoff/project_charter.md)
- [Sprint Ceremonies](project_kickoff/ceremonies.md)
- [Definition of Ready](project_kickoff/definition-of-ready.md)
- [Definition of Done](project_kickoff/dod.md)
- [Team Norms](project_kickoff/team_norms.md)
- [Meeting Etiquette](project_kickoff/meeting-etiquette.md)
- [Securing Your Workspace](project_kickoff/securing_your_workspace.md)

## Vision & Roadmap

- [Customer Development](/vision_and_roadmap/customer_development_playbook.md)
- [Product Speclet](/vision_and_roadmap/speclet.md) + [Template](/vision_and_roadmap/speclet_template.md)
- [Visualizing the future of product initiatives as a cross-functional team](/vision_and_roadmap/visualizing-product-initiatives.md) + [Template](https://www.figma.com/file/kEVk8PaoLbCqI8liK5Emgh/%5BInitiative-Name%5D-Visualization-Summary?type=whiteboard&node-id=0%3A1&t=Dq0dcV75It3GqXxP-1)
- [Customer Development](vision_and_roadmap/customer_development_playbook.md)
- [Product Speclet](vision_and_roadmap/speclet.md) + [Template](vision_and_roadmap/speclet_template.md)
- [Visualizing the future of product initiatives as a cross-functional team](vision_and_roadmap/visualizing-product-initiatives.md) + [Template](https://www.figma.com/file/kEVk8PaoLbCqI8liK5Emgh/%5BInitiative-Name%5D-Visualization-Summary?type=whiteboard&node-id=0%3A1&t=Dq0dcV75It3GqXxP-1)

## Product Design

- [Design Principles](/product_design/design_principles.md)
- [Design Review](/product_design/design-review-best-practices.md)
- [Giving and Receiving Feedback](/product_design/giving-and-receiving-design-feedback.md)
- [How to Write User Stories](/product_design/how_we_write_user_stories.md)
- [Accessibility](/product_design/accessibility_guide.md)
- [Design Principles](product_design/design_principles.md)
- [Design Review](product_design/design-review-best-practices.md)
- [Giving and Receiving Feedback](product_design/giving-and-receiving-design-feedback.md)
- [How to Write User Stories](product_design/how_we_write_user_stories.md)
- [Accessibility](product_design/accessibility_guide.md)

## Continuous Delivery

- [Development Workflow](/continuous_delivery/development_workflow.md)
- [Testing Strategy](/continuous_delivery/testing_strategy.md)
- [Git Commit Guide](/continuous_delivery/commit_guide.md)
- [README Guide](/continuous_delivery/readme_guide.md)
- [Sprint Demo Guide](/continuous_delivery/demo_guide.md)
- [Development Workflow](continuous_delivery/development_workflow.md)
- [Testing Strategy](continuous_delivery/testing_strategy.md)
- [Git Commit Guide](continuous_delivery/commit_guide.md)
- [README Guide](continuous_delivery/readme_guide.md)
- [Sprint Demo Guide](continuous_delivery/demo_guide.md)

## Technical Guides

- [Ruby on Rails](/technical_guides/ruby_on_rails.md)
- [Javascript](/technical_guides/javascript-code-style-quality-rules.md)
- [Testing React Applications](/technical_guides/react-testing.md)
- [Ruby on Rails](technical_guides/ruby_on_rails.md)
- [Javascript](technical_guides/javascript-code-style-quality-rules.md)
- [Testing React Applications](technical_guides/react-testing.md)
- [CSS](technical_guides/css.md)
- [Chef](technical_guides/chef.md)
- [Dev Ops Runbook Guide](/technical_guides/dev_ops_runbook_guide.md)
- [Dev Ops Runbook Guide](technical_guides/dev_ops_runbook_guide.md)

2 changes: 1 addition & 1 deletion project_kickoff/securing_your_workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Working securely is important to Lab Zero and our clients. With a few simple tri
* Never leave your laptop unlocked. Don't walk away for lunch or an errand without locking your computer.
- Tip: Use Hot Corners in the Screen Saver preferences to easily lock computer when walking away.
* Keep your laptop in a safe place. e.g. Not in your car's front seat. Cars are broken into very often. If you must leave it in your car, put it in the trunk or hide it well.
* Use a password manager, like 1Password (paid) or LastPass (free) to keep your passwords hard and secure between sites. Don't write passwords down on paper or share them with others.
* Use a password manager, like 1Password (paid) or Bitwarden (free) to keep your passwords hard and secure between sites. Don't write passwords down on paper or share them with others.
* Use Multi-Factor Authentication whenever possible. As a bare minimum, use it on Github, Google, AWS, Slack and any client provided service accounts.
* Never store production secrets/keys on your machine. They should only reside on the servers that need them, and on the configuration management system (in an encrypted format).
* Do not share SSH keys with team members. Use an SSH key specific to your machine, and have that key whitelisted on the systems you need to access. This reduces the impact of a compromised key significantly.
Expand Down
4 changes: 2 additions & 2 deletions vision_and_roadmap/visualizing-product-initiatives.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Our ideal team for vision exploration is a product manager, a design lead, and a

Adapt this core team structure to meet your needs. As an example, you may experiment with having two designers on your cross-functional team. In this scenario, one designer acts as a facilitator assisting the team with the process while the other focuses on customer needs and solutions.

At Lab Zero, design usually drives this process since they are closest to customer needs and often have the rapid prototyping skills necessary to explore ideas quickly. That said, there’s no reason product or engineering can’t be the driver. Product, design, and engineering have many overlapping skills and capabilities. Each individual’s skills and comfort zones will vary. It’s worth having a conversation to decide who drives the work and who will be responsible for what. Use a [RACI matrix](https://www.nngroup.com/articles/ux-roles-responsibilities/) as part of a [norming session](/project_kickoff/team_norms.md) to help determine roles and responsibilities.
At Lab Zero, design usually drives this process since they are closest to customer needs and often have the rapid prototyping skills necessary to explore ideas quickly. That said, there’s no reason product or engineering can’t be the driver. Product, design, and engineering have many overlapping skills and capabilities. Each individual’s skills and comfort zones will vary. It’s worth having a conversation to decide who drives the work and who will be responsible for what. Use a [RACI matrix](https://www.nngroup.com/articles/ux-roles-responsibilities/) as part of a [norming session](../project_kickoff/team_norms.md) to help determine roles and responsibilities.


#### Identify your partners
Expand Down Expand Up @@ -199,5 +199,5 @@ When it’s time to create your next initiative visualization, consider swapping

It’s like exercising. The more your team practices creating and executing from initiative visualizations, the easier it will be. Each visualization process lays the foundation for the next one.

## Your feedback is welcome
## Your feedback is welcome
Have you tried this process or something similar? We want to hear what worked well and what could have gone better so that we may continue to refine and improve. Please get in touch to share your thoughts.