Strong-Tie UXR Documentation
Research Repository

Command Palette

Search for a command to run...

Q4 2025
  • Platform Model (BIM) Viewer
  • (Preliminary Report) Project Hub Research
  • Personas
Q3 2025
  • Estimating Tools Unification
  • Outdoor Living Solutions Pro Tier
  • Director Engineering Tab
  • Roles and Permissions
  • Cornerstone Point Offsetting Discovery
  • Truss Design Seal Submittal Workflow
Q2 2025
  • CS Engineer
  • Digital Solutions CSAT/NPS Survey
  • Past Communication Research
  • Director Admin Settings
  • Director Pricing
Q1 2025
  • License and Account Management
  • Estimating JTBD Survey
  • Product Materials Catalogs
  • Truss Studio Settings / Envdata
  • Residential Construction Ecosystem
  • Cloud Director Project Creation
Q4 2024
  • Platform Discovery Research Findings
  • Director Settings
  • Truss Studio Ribbon Bar
  • Cloud Director Roles and Permissions
  • Deck Planner Pro Features
Q3 2024
  • ICS Assessment and Platform Features
  • Document Management Services
  • LotSpec for Revit
  • LotSpec for Revit User Personas
Q2 2024
  • Platform Sprint
  • LBM Estimating Digital Portal Discovery
  • LBM Q2 Customer Interviews
  • Fastener Designer Prototype Testing
  • Production Scheduler
  • LotSpec for Revit Competitive Analysis
  • Field Verification
  • Kentley Insights Truss Market Research
Q1 2024
  • LBM Takeoff Tool MVP Testing
  • Anchor Finder
  • LBM Q1 Customer Interviews
  • Customer Connectivity
  • Reporting Manager Modal
Q4 2023
  • PDP Heatmapping
  • Pipeline Modernization
  • Truss Studio Envdata
  • Enterprise User Roles Prototype Test
Q3 2023
  • Reporting Manager Parameters
  • Customer Portal Jump
Q2 2023
  • Internal UX Team Satisfaction Survey
  • PDP Navigation
2026 Simpson Strong-Tie
  1. Docs
  2. Getting Started
  3. Contributing to UXR Documentation

Contributing to UXR Documentation

PreviousNext

Guidelines for adding and updating research documentation

Contributing to UXR Documentation

This guide will help you add research findings, update documentation, and maintain the UXR knowledge base.

Who Can Contribute?

  • UX Researchers - Add completed studies, insights, and methodologies
  • Product Managers - Share relevant user feedback and feature insights
  • Designers - Contribute usability findings and design validation
  • Engineers - Add technical research and implementation insights
  • Anyone - Fix typos, improve clarity, or suggest improvements

Quick Start

Adding a New Research Study

  1. Navigate to content/docs/studies/
  2. Create a new MDX file: study-name.mdx
  3. Use this template:
---
title: Study Title
description: Brief description of the study
date: 2024-01-15
status: completed
tags: [usability, interviews, quantitative]
---
 
# Study Title
 
## Overview
 
Brief overview of the research study.
 
## Research Questions
 
1. What did we want to learn?
2. What problems were we solving?
 
## Methodology
 
- **Type**: User interviews, surveys, usability testing, etc.
- **Participants**: Number and description
- **Duration**: Timeline
- **Tools**: Software and tools used
 
## Key Findings
 
### Finding 1
 
Description of the finding and supporting evidence.
 
### Finding 2
 
Description of the finding and supporting evidence.
 
## Recommendations
 
1. Actionable recommendation based on findings
2. Another recommendation with priority level
 
## Impact
 
What changed as a result of this research?
 
## Related Studies
 
Links to related research studies or insights.

Adding Research Methods

Document your research methodology in content/docs/methods/:

---
title: Method Name
description: When and how to use this research method
---
 
# Method Name
 
## What is it?
 
Brief description of the research method.
 
## When to Use
 
- Use case 1
- Use case 2
- Use case 3
 
## How to Conduct
 
Step-by-step guide for executing this method.
 
## Best Practices
 
Tips and recommendations for success.
 
## Templates & Resources
 
Links to templates, scripts, and helpful resources.

Adding User Personas

Create or update personas in content/docs/personas/:

---
title: Persona Name
description: Brief description of the user type
lastUpdated: 2024-01-15
---
 
# Persona Name
 
## Demographics
 
- **Age Range**: 25-45
- **Role**: Job title or role
- **Experience Level**: Beginner/Intermediate/Expert
 
## Goals & Motivations
 
What does this user want to accomplish?
 
## Pain Points
 
What challenges do they face?
 
## Behaviors & Preferences
 
How do they work? What are their habits?
 
## Quotes
 
> "Representative quote from user research"
 
## Related Research
 
Links to studies that informed this persona.

Adding Insights

Document key insights in content/docs/insights/:

---
title: Insight Title
description: Brief summary of the insight
date: 2024-01-15
category: navigation | onboarding | accessibility | etc.
confidence: high | medium | low
---
 
# Insight Title
 
## The Insight
 
Clear statement of what we learned.
 
## Evidence
 
Data, quotes, or observations supporting this insight.
 
## Implications
 
What does this mean for our products?
 
## Actions Taken
 
What we did based on this insight.
 
## Related Content
 
Links to related studies, personas, or insights.

Content Guidelines

Writing Style

  • Be clear and concise - Get to the point quickly
  • Use active voice - "We conducted interviews" not "Interviews were conducted"
  • Include evidence - Back up claims with data, quotes, or observations
  • Be objective - Present findings without bias
  • Use headings - Break content into scannable sections

Formatting

  • Use MDX for all documentation files
  • Include frontmatter metadata at the top of each file
  • Use relative links for internal references
  • Add tags for searchability
  • Include dates for time-sensitive content

File Naming

  • Use lowercase with hyphens: usability-testing-guide.mdx
  • Be descriptive: mobile-app-navigation-study-2024.mdx
  • Include dates for studies: q1-2024-user-interviews.mdx

MDX Features

This documentation supports MDX, which means you can use React components:

Callouts

<Callout type="info">Important information to highlight</Callout>
 
<Callout type="warning">Warning or caution for readers</Callout>

Cards

<CardGroup cols={2}>
  <Card title="Card Title" description="Card description" href="/link" />
</CardGroup>

Tabs

<Tabs defaultValue="tab1">
  <TabsList>
    <TabsTrigger value="tab1">Tab 1</TabsTrigger>
    <TabsTrigger value="tab2">Tab 2</TabsTrigger>
  </TabsList>
  <TabsContent value="tab1">Content for tab 1</TabsContent>
  <TabsContent value="tab2">Content for tab 2</TabsContent>
</Tabs>

Review Process

  1. Create your content - Write your documentation in MDX
  2. Preview locally - Run npm run dev to preview changes
  3. Self-review - Check for typos, formatting, and completeness
  4. Submit for review - Create a pull request or share with the team
  5. Incorporate feedback - Address any comments or suggestions
  6. Publish - Merge and deploy your changes

Best Practices

For Research Studies

  • Include participant quotes to illustrate findings
  • Use visualizations (charts, diagrams) when helpful
  • Link to raw data or detailed reports when available
  • Tag studies for easy discovery
  • Update studies if follow-up research changes conclusions

For Methods Documentation

  • Include when to use (and when NOT to use) each method
  • Provide templates and resources
  • Share common pitfalls and how to avoid them
  • Link to example studies that used the method

For Personas

  • Base personas on actual research, not assumptions
  • Update personas as you learn more
  • Include confidence levels for different aspects
  • Reference the research that informed each persona

For Insights

  • Make insights actionable
  • Include confidence levels
  • Show your work (link to supporting research)
  • Track what actions resulted from insights

Need Help?

  • Questions about content structure? Check existing documentation for examples
  • Technical issues? Reach out to the development team
  • Research methodology questions? Connect with the UXR team

Maintenance

Documentation should be a living resource:

  • Review quarterly - Ensure information is still relevant
  • Archive outdated content - Move old studies to an archive section
  • Update cross-references - Fix broken links and references
  • Improve searchability - Add tags and improve titles as needed

Thank you for contributing to our UXR documentation! Your research helps the entire organization make better, user-informed decisions.

Getting StartedInstalling the @strongtie/design-system Package

On This Page

Contributing to UXR DocumentationWho Can Contribute?Quick StartAdding a New Research StudyAdding Research MethodsAdding User PersonasAdding InsightsContent GuidelinesWriting StyleFormattingFile NamingMDX FeaturesCalloutsCardsTabsReview ProcessBest PracticesFor Research StudiesFor Methods DocumentationFor PersonasFor InsightsNeed Help?Maintenance

Contribute

  • Report an issue
  • Request a feature
  • Edit this page